NSX-T Data Center REST API

ALBAcceptedCipherEnums (type)

{
  "description": "Valid ENUM values for ALBAcceptedCipherEnums", 
  "enum": [
    "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", 
    "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_256_GCM_SHA384", 
    "TLS_RSA_WITH_AES_128_CBC_SHA256", 
    "TLS_RSA_WITH_AES_256_CBC_SHA256", 
    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", 
    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", 
    "TLS_RSA_WITH_AES_128_CBC_SHA", 
    "TLS_RSA_WITH_AES_256_CBC_SHA", 
    "TLS_RSA_WITH_3DES_EDE_CBC_SHA", 
    "TLS_AES_256_GCM_SHA384", 
    "TLS_CHACHA20_POLY1305_SHA256", 
    "TLS_AES_128_GCM_SHA256"
  ], 
  "id": "ALBAcceptedCipherEnums", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AcceptedCipherEnums type", 
  "type": "string"
}

ALBActiveStandbySeTag (type)

{
  "description": "Valid ENUM values for ALBActiveStandbySeTag", 
  "enum": [
    "ACTIVE_STANDBY_SE_1", 
    "ACTIVE_STANDBY_SE_2"
  ], 
  "id": "ALBActiveStandbySeTag", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ActiveStandbySeTag type", 
  "type": "string"
}

ALBAlertScriptConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AlertScriptConfig object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBAlertScriptConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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_script": {
      "description": "User Defined Alert Action Script. Please refer to kb.avinetworks.com for more information.", 
      "required": false, 
      "title": "Action script", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "AlertScriptConfig", 
  "type": "object"
}

ALBAnalyticsPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AnalyticsPolicy object", 
  "id": "ALBAnalyticsPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "all_headers": {
      "default": false, 
      "description": "Log all headers. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "All headers", 
      "type": "boolean"
    }, 
    "client_insights": {
      "$ref": "ALBClientInsights, 
      "default": "NO_INSIGHTS", 
      "description": "Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Default value when not specified in API or module is interpreted by ALB Controller as NO_INSIGHTS.", 
      "required": false, 
      "title": "Client insights"
    }, 
    "client_insights_sampling": {
      "$ref": "ALBClientInsightsSampling, 
      "description": "Placeholder for description of property client_insights_sampling of obj type AnalyticsPolicy field type str  type ref.", 
      "required": false, 
      "title": "Client insights sampling"
    }, 
    "client_log_filters": {
      "description": "Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str  type array.", 
      "items": {
        "$ref": "ALBClientLogFilter
      }, 
      "required": false, 
      "title": "Client log filters", 
      "type": "array"
    }, 
    "full_client_logs": {
      "$ref": "ALBFullClientLogs, 
      "description": "Placeholder for description of property full_client_logs of obj type AnalyticsPolicy field type str  type ref.", 
      "required": false, 
      "title": "Full client logs"
    }, 
    "metrics_realtime_update": {
      "$ref": "ALBMetricsRealTimeUpdate, 
      "description": "Settings to turn on realtime metrics and set duration for realtime updates.", 
      "required": false, 
      "title": "Metrics realtime update"
    }, 
    "significant_log_throttle": {
      "default": 10, 
      "description": "This setting limits the number of significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "required": false, 
      "title": "Significant log throttle", 
      "type": "integer"
    }, 
    "udf_log_throttle": {
      "default": 10, 
      "description": "This setting limits the total number of UDF logs generated per second for this VS on each SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "required": false, 
      "title": "Udf log throttle", 
      "type": "integer"
    }
  }, 
  "title": "AnalyticsPolicy", 
  "type": "object"
}

ALBAnalyticsProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AnalyticsProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBAnalyticsProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "apdex_response_threshold": {
      "default": 500, 
      "description": "If a client receives an HTTP response in less than the Satisfactory Latency Threshold, the request is considered Satisfied. It is considered Tolerated if it is not Satisfied and less than Tolerated Latency Factor multiplied by the Satisfactory Latency Threshold. Greater than this number and the client's request is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 500) edition, Essentials(Allowed values- 500) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 500.", 
      "maximum": 30000, 
      "minimum": 1, 
      "required": false, 
      "title": "Apdex response threshold", 
      "type": "integer"
    }, 
    "apdex_response_tolerated_factor": {
      "default": 4.0, 
      "description": "Client tolerated response latency factor. Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Apdex response tolerated factor", 
      "type": "number"
    }, 
    "apdex_rtt_threshold": {
      "default": 250, 
      "description": "Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 250) edition, Essentials(Allowed values- 250) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 250.", 
      "maximum": 2000, 
      "minimum": 1, 
      "required": false, 
      "title": "Apdex rtt threshold", 
      "type": "integer"
    }, 
    "apdex_rtt_tolerated_factor": {
      "default": 4.0, 
      "description": "Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Apdex rtt tolerated factor", 
      "type": "number"
    }, 
    "apdex_rum_threshold": {
      "default": 5000, 
      "description": "If a client is able to load a page in less than the Satisfactory Latency Threshold, the PageLoad is considered Satisfied. It is considered tolerated if it is greater than Satisfied but less than the Tolerated Latency multiplied by Satisifed Latency. Greater than this number and the client's request is considered Frustrated. A PageLoad includes the time for DNS lookup, download of all HTTP objects, and page render time. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 5000) edition, Essentials(Allowed values- 5000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5000.", 
      "maximum": 30000, 
      "minimum": 1, 
      "required": false, 
      "title": "Apdex rum threshold", 
      "type": "integer"
    }, 
    "apdex_rum_tolerated_factor": {
      "default": 4.0, 
      "description": "Virtual service threshold factor for tolerated Page Load Time (PLT) as multiple of apdex_rum_threshold. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Apdex rum tolerated factor", 
      "type": "number"
    }, 
    "apdex_server_response_threshold": {
      "default": 400, 
      "description": "A server HTTP response is considered Satisfied if latency is less than the Satisfactory Latency Threshold. The response is considered tolerated when it is greater than Satisfied but less than the Tolerated Latency Factor (STAR) S_Latency. Greater than this number and the server response is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 400) edition, Essentials(Allowed values- 400) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 400.", 
      "maximum": 30000, 
      "minimum": 1, 
      "required": false, 
      "title": "Apdex server response threshold", 
      "type": "integer"
    }, 
    "apdex_server_response_tolerated_factor": {
      "default": 4.0, 
      "description": "Server tolerated response latency factor. Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Apdex server response tolerated factor", 
      "type": "number"
    }, 
    "apdex_server_rtt_threshold": {
      "default": 125, 
      "description": "Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 125) edition, Essentials(Allowed values- 125) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 125.", 
      "maximum": 2000, 
      "minimum": 1, 
      "required": false, 
      "title": "Apdex server rtt threshold", 
      "type": "integer"
    }, 
    "apdex_server_rtt_tolerated_factor": {
      "default": 4.0, 
      "description": "Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Apdex server rtt tolerated factor", 
      "type": "number"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "client_log_config": {
      "$ref": "ALBClientLogConfiguration, 
      "description": "Configure which logs are sent to the Avi Controller from SEs and how they are processed.", 
      "required": false, 
      "title": "Client log config"
    }, 
    "client_log_streaming_config": {
      "$ref": "ALBClientLogStreamingConfig, 
      "description": "Configure to stream logs to an external server. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Client log streaming config"
    }, 
    "conn_lossy_ooo_threshold": {
      "default": 50, 
      "description": "A connection between client and Avi is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 50.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn lossy ooo threshold", 
      "type": "integer"
    }, 
    "conn_lossy_timeo_rexmt_threshold": {
      "default": 20, 
      "description": "A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 20.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn lossy timeo rexmt threshold", 
      "type": "integer"
    }, 
    "conn_lossy_total_rexmt_threshold": {
      "default": 50, 
      "description": "A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 50.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn lossy total rexmt threshold", 
      "type": "integer"
    }, 
    "conn_lossy_zero_win_size_event_threshold": {
      "default": 2, 
      "description": "A client connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Conn lossy zero win size event threshold", 
      "type": "integer"
    }, 
    "conn_server_lossy_ooo_threshold": {
      "default": 50, 
      "description": "A connection between Avi and server is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 50.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn server lossy ooo threshold", 
      "type": "integer"
    }, 
    "conn_server_lossy_timeo_rexmt_threshold": {
      "default": 20, 
      "description": "A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 20.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn server lossy timeo rexmt threshold", 
      "type": "integer"
    }, 
    "conn_server_lossy_total_rexmt_threshold": {
      "default": 50, 
      "description": "A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 50.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Conn server lossy total rexmt threshold", 
      "type": "integer"
    }, 
    "conn_server_lossy_zero_win_size_event_threshold": {
      "default": 2, 
      "description": "A server connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Conn server lossy zero win size event threshold", 
      "type": "integer"
    }, 
    "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"
    }, 
    "enable_adaptive_config": {
      "default": true, 
      "description": "Enable adaptive configuration for optimizing resource usage. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable adaptive config", 
      "type": "boolean"
    }, 
    "enable_advanced_analytics": {
      "default": false, 
      "description": "Enables Advanced Analytics features like Anomaly detection. If set to false, anomaly computation (and associated rules/events) for VS, Pool and Server metrics will be deactivated. However, setting it to false reduces cpu and memory requirements for Analytics subsystem. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable advanced analytics", 
      "type": "boolean"
    }, 
    "enable_ondemand_metrics": {
      "default": true, 
      "description": "Virtual Service (VS) metrics are processed only when there is live data traffic on the VS. In case, VS is idle for a period of time as specified by ondemand_metrics_idle_timeout then metrics processing is suspended for that VS. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable ondemand metrics", 
      "type": "boolean"
    }, 
    "enable_se_analytics": {
      "default": true, 
      "description": "Enable node (service engine) level analytics forvs metrics. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable se analytics", 
      "type": "boolean"
    }, 
    "enable_server_analytics": {
      "default": true, 
      "description": "Enables analytics on backend servers. This may be desired in container environment when there are large number of ephemeral servers. Additionally, no healthscore of servers is computed when server analytics is enabled. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable server analytics", 
      "type": "boolean"
    }, 
    "enable_vs_analytics": {
      "default": true, 
      "description": "Enable VirtualService (frontend) Analytics. This flag enables metrics and healthscore for Virtualservice. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable vs analytics", 
      "type": "boolean"
    }, 
    "exclude_client_close_before_request_as_error": {
      "default": false, 
      "description": "Exclude client closed connection before an HTTP request could be completed from being classified as an error. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude client close before request as error", 
      "type": "boolean"
    }, 
    "exclude_dns_policy_drop_as_significant": {
      "default": false, 
      "description": "Exclude dns policy drops from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude dns policy drop as significant", 
      "type": "boolean"
    }, 
    "exclude_gs_down_as_error": {
      "default": false, 
      "description": "Exclude queries to GSLB services that are operationally down from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude gs down as error", 
      "type": "boolean"
    }, 
    "exclude_http_error_codes": {
      "description": "List of HTTP status codes to be excluded from being classified as an error. Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a DoS attack.", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Exclude http error codes", 
      "type": "array"
    }, 
    "exclude_invalid_dns_domain_as_error": {
      "default": false, 
      "description": "Exclude dns queries to domains outside the domains configured in the DNS application profile from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude invalid dns domain as error", 
      "type": "boolean"
    }, 
    "exclude_invalid_dns_query_as_error": {
      "default": false, 
      "description": "Exclude invalid dns queries from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude invalid dns query as error", 
      "type": "boolean"
    }, 
    "exclude_issuer_revoked_ocsp_responses_as_error": {
      "default": true, 
      "description": "Exclude the Issuer-Revoked OCSP Responses from the list of errors. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Exclude issuer revoked ocsp responses as error", 
      "type": "boolean"
    }, 
    "exclude_no_dns_record_as_error": {
      "default": false, 
      "description": "Exclude queries to domains that did not have configured services/records from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude no dns record as error", 
      "type": "boolean"
    }, 
    "exclude_no_valid_gs_member_as_error": {
      "default": false, 
      "description": "Exclude queries to GSLB services that have no available members from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude no valid gs member as error", 
      "type": "boolean"
    }, 
    "exclude_persistence_change_as_error": {
      "default": false, 
      "description": "Exclude persistence server changed while load balancing' from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude persistence change as error", 
      "type": "boolean"
    }, 
    "exclude_revoked_ocsp_responses_as_error": {
      "default": true, 
      "description": "Exclude the Revoked OCSP certificate status responses from the list of errors. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Exclude revoked ocsp responses as error", 
      "type": "boolean"
    }, 
    "exclude_server_dns_error_as_error": {
      "default": false, 
      "description": "Exclude server dns error response from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude server dns error as error", 
      "type": "boolean"
    }, 
    "exclude_server_tcp_reset_as_error": {
      "default": false, 
      "description": "Exclude server TCP reset from errors. It is common for applications like MS Exchange. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude server tcp reset as error", 
      "type": "boolean"
    }, 
    "exclude_sip_error_codes": {
      "description": "List of SIP status codes to be excluded from being classified as an error. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Exclude sip error codes", 
      "type": "array"
    }, 
    "exclude_stale_ocsp_responses_as_error": {
      "default": true, 
      "description": "Exclude the Stale OCSP certificate status responses from the list of errors. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Exclude stale ocsp responses as error", 
      "type": "boolean"
    }, 
    "exclude_syn_retransmit_as_error": {
      "default": false, 
      "description": "Exclude 'server unanswered syns' from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude syn retransmit as error", 
      "type": "boolean"
    }, 
    "exclude_tcp_reset_as_error": {
      "default": false, 
      "description": "Exclude TCP resets by client from the list of potential errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude tcp reset as error", 
      "type": "boolean"
    }, 
    "exclude_unavailable_ocsp_responses_as_error": {
      "default": true, 
      "description": "Exclude the unavailable OCSP Responses from the list of errors. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Exclude unavailable ocsp responses as error", 
      "type": "boolean"
    }, 
    "exclude_unsupported_dns_query_as_error": {
      "default": false, 
      "description": "Exclude unsupported dns queries from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exclude unsupported dns query as error", 
      "type": "boolean"
    }, 
    "healthscore_max_server_limit": {
      "default": 0, 
      "description": "Skips health score computation of pool servers when number of servers in a pool is more than this setting. Allowed values are 0-5000. Special values are 0- 'server health score is deactivated'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 20. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 5000, 
      "minimum": 0, 
      "required": false, 
      "title": "Healthscore max server limit", 
      "type": "integer"
    }, 
    "hs_event_throttle_window": {
      "default": 1209600, 
      "description": "Time window (in secs) within which only unique health change events should occur. Allowed in Basic(Allowed values- 1209600) edition, Essentials(Allowed values- 1209600) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1209600.", 
      "required": false, 
      "title": "Hs event throttle window", 
      "type": "integer"
    }, 
    "hs_max_anomaly_penalty": {
      "default": 10, 
      "description": "Maximum penalty that may be deducted from health score for anomalies. Allowed values are 0-100. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Hs max anomaly penalty", 
      "type": "integer"
    }, 
    "hs_max_resources_penalty": {
      "default": 25, 
      "description": "Maximum penalty that may be deducted from health score for high resource utilization. Allowed values are 0-100. Allowed in Basic(Allowed values- 25) edition, Essentials(Allowed values- 25) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 25.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Hs max resources penalty", 
      "type": "integer"
    }, 
    "hs_max_security_penalty": {
      "default": 100, 
      "description": "Maximum penalty that may be deducted from health score based on security assessment. Allowed values are 0-100. Allowed in Basic(Allowed values- 100) edition, Essentials(Allowed values- 100) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Hs max security penalty", 
      "type": "integer"
    }, 
    "hs_min_dos_rate": {
      "default": 1000, 
      "description": "DoS connection rate below which the DoS security assessment will not kick in. Allowed in Basic(Allowed values- 1000) edition, Essentials(Allowed values- 1000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1000.", 
      "required": false, 
      "title": "Hs min dos rate", 
      "type": "integer"
    }, 
    "hs_performance_boost": {
      "default": 0, 
      "description": "Adds free performance score credits to health score. It can be used for compensating health score for known slow applications. Allowed values are 0-100. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Hs performance boost", 
      "type": "integer"
    }, 
    "hs_pscore_traffic_threshold_l4_client": {
      "default": 10.0, 
      "description": "Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 10.0.", 
      "required": false, 
      "title": "Hs pscore traffic threshold l4 client", 
      "type": "number"
    }, 
    "hs_pscore_traffic_threshold_l4_server": {
      "default": 10.0, 
      "description": "Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 10.0.", 
      "required": false, 
      "title": "Hs pscore traffic threshold l4 server", 
      "type": "number"
    }, 
    "hs_security_certscore_expired": {
      "default": 0.0, 
      "description": "Score assigned when the certificate has expired. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.0.", 
      "required": false, 
      "title": "Hs security certscore expired", 
      "type": "number"
    }, 
    "hs_security_certscore_gt30d": {
      "default": 5.0, 
      "description": "Score assigned when the certificate expires in more than 30 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5.0.", 
      "required": false, 
      "title": "Hs security certscore gt30d", 
      "type": "number"
    }, 
    "hs_security_certscore_le07d": {
      "default": 2.0, 
      "description": "Score assigned when the certificate expires in less than or equal to 7 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 2.0) edition, Essentials(Allowed values- 2.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2.0.", 
      "required": false, 
      "title": "Hs security certscore le07d", 
      "type": "number"
    }, 
    "hs_security_certscore_le30d": {
      "default": 4.0, 
      "description": "Score assigned when the certificate expires in less than or equal to 30 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 4.0) edition, Essentials(Allowed values- 4.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 4.0.", 
      "required": false, 
      "title": "Hs security certscore le30d", 
      "type": "number"
    }, 
    "hs_security_chain_invalidity_penalty": {
      "default": 1.0, 
      "description": "Penalty for allowing certificates with invalid chain. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.0.", 
      "required": false, 
      "title": "Hs security chain invalidity penalty", 
      "type": "number"
    }, 
    "hs_security_cipherscore_eq000b": {
      "default": 0.0, 
      "description": "Score assigned when the minimum cipher strength is 0 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.0.", 
      "required": false, 
      "title": "Hs security cipherscore eq000b", 
      "type": "number"
    }, 
    "hs_security_cipherscore_ge128b": {
      "default": 5.0, 
      "description": "Score assigned when the minimum cipher strength is greater than equal to 128 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5.0.", 
      "required": false, 
      "title": "Hs security cipherscore ge128b", 
      "type": "number"
    }, 
    "hs_security_cipherscore_lt128b": {
      "default": 3.5, 
      "description": "Score assigned when the minimum cipher strength is less than 128 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 3.5) edition, Essentials(Allowed values- 3.5) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 3.5.", 
      "required": false, 
      "title": "Hs security cipherscore lt128b", 
      "type": "number"
    }, 
    "hs_security_encalgo_score_none": {
      "default": 0.0, 
      "description": "Score assigned when no algorithm is used for encryption. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.0.", 
      "required": false, 
      "title": "Hs security encalgo score none", 
      "type": "number"
    }, 
    "hs_security_encalgo_score_rc4": {
      "default": 2.5, 
      "description": "Score assigned when RC4 algorithm is used for encryption. Allowed values are 0-5. Allowed in Basic(Allowed values- 2.5) edition, Essentials(Allowed values- 2.5) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2.5.", 
      "required": false, 
      "title": "Hs security encalgo score rc4", 
      "type": "number"
    }, 
    "hs_security_hsts_penalty": {
      "default": 1.0, 
      "description": "Penalty for not enabling HSTS. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.0.", 
      "required": false, 
      "title": "Hs security hsts penalty", 
      "type": "number"
    }, 
    "hs_security_nonpfs_penalty": {
      "default": 1.0, 
      "description": "Penalty for allowing non-PFS handshakes. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.0.", 
      "required": false, 
      "title": "Hs security nonpfs penalty", 
      "type": "number"
    }, 
    "hs_security_ocsp_revoked_score": {
      "default": 0.0, 
      "description": "Score assigned when OCSP Certificate Status is set to Revoked or Issuer Revoked. Allowed values are 0.0-5.0. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.0.", 
      "required": false, 
      "title": "Hs security ocsp revoked score", 
      "type": "number"
    }, 
    "hs_security_selfsignedcert_penalty": {
      "default": 1.0, 
      "description": "Deprecated. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.0.", 
      "required": false, 
      "title": "Hs security selfsignedcert penalty", 
      "type": "number"
    }, 
    "hs_security_ssl30_score": {
      "default": 3.5, 
      "description": "Score assigned when supporting SSL3.0 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 3.5) edition, Essentials(Allowed values- 3.5) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 3.5.", 
      "required": false, 
      "title": "Hs security ssl30 score", 
      "type": "number"
    }, 
    "hs_security_tls10_score": {
      "default": 5.0, 
      "description": "Score assigned when supporting TLS1.0 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5.0.", 
      "required": false, 
      "title": "Hs security tls10 score", 
      "type": "number"
    }, 
    "hs_security_tls11_score": {
      "default": 5.0, 
      "description": "Score assigned when supporting TLS1.1 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5.0.", 
      "required": false, 
      "title": "Hs security tls11 score", 
      "type": "number"
    }, 
    "hs_security_tls12_score": {
      "default": 5.0, 
      "description": "Score assigned when supporting TLS1.2 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 5.0.", 
      "required": false, 
      "title": "Hs security tls12 score", 
      "type": "number"
    }, 
    "hs_security_tls13_score": {
      "description": "Score assigned when supporting TLS1.3 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition.", 
      "required": false, 
      "title": "Hs security tls13 score", 
      "type": "number"
    }, 
    "hs_security_weak_signature_algo_penalty": {
      "default": 1.0, 
      "description": "Penalty for allowing weak signature algorithm(s). Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.0.", 
      "required": false, 
      "title": "Hs security weak signature algo penalty", 
      "type": "number"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "ondemand_metrics_idle_timeout": {
      "default": 1800, 
      "description": "This flag sets the time duration of no live data traffic after which Virtual Service metrics processing is suspended. It is applicable only when enable_ondemand_metrics is set to false. Unit is SECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 1800.", 
      "required": false, 
      "title": "Ondemand metrics idle timeout", 
      "type": "integer"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "ranges": {
      "description": "List of HTTP status code ranges to be excluded from being classified as an error.", 
      "items": {
        "$ref": "ALBHTTPStatusRange
      }, 
      "required": false, 
      "title": "Ranges", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "resp_code_block": {
      "description": "Block of HTTP response codes to be excluded from being classified as an error. Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX.", 
      "items": {
        "$ref": "ALBAnalyticsProfileRespCodeBlock
      }, 
      "required": false, 
      "title": "Resp code block", 
      "type": "array"
    }, 
    "sensitive_log_profile": {
      "$ref": "ALBSensitiveLogProfile, 
      "description": "Rules applied to the HTTP application log for filtering sensitive information. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Sensitive log profile"
    }, 
    "sip_log_depth": {
      "default": 20, 
      "description": "Maximum number of SIP messages added in logs for a SIP transaction. By default, this value is 20. Allowed values are 1-1000. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 20.", 
      "maximum": 1000, 
      "minimum": 1, 
      "required": false, 
      "title": "Sip log depth", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "AnalyticsProfile", 
  "type": "object"
}

ALBAnalyticsProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "AnalyticsProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBAnalyticsProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of AnalyticsProfile", 
      "items": {
        "$ref": "ALBAnalyticsProfile
      }, 
      "required": false, 
      "title": "Array of AnalyticsProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AnalyticsProfileApiResponse", 
  "type": "object"
}

ALBAnalyticsProfileRespCodeBlock (type)

{
  "description": "Valid ENUM values for ALBAnalyticsProfileRespCodeBlock", 
  "enum": [
    "AP_HTTP_RSP_4XX", 
    "AP_HTTP_RSP_5XX"
  ], 
  "id": "ALBAnalyticsProfileRespCodeBlock", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AnalyticsProfileRespCodeBlock type", 
  "type": "string"
}

ALBAppCookiePersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AppCookiePersistenceProfile object", 
  "id": "ALBAppCookiePersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "encryption_key": {
      "description": "Key to use for cookie encryption.", 
      "required": false, 
      "title": "Encryption key", 
      "type": "string"
    }, 
    "prst_hdr_name": {
      "description": "Header or cookie name for application cookie persistence.", 
      "required": true, 
      "title": "Prst hdr name", 
      "type": "string"
    }, 
    "timeout": {
      "default": 20, 
      "description": "The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 20.", 
      "maximum": 720, 
      "minimum": 1, 
      "required": false, 
      "title": "Timeout", 
      "type": "integer"
    }
  }, 
  "title": "AppCookiePersistenceProfile", 
  "type": "object"
}

ALBAppLearningConfidenceLabel (type)

{
  "description": "Valid ENUM values for ALBAppLearningConfidenceLabel", 
  "enum": [
    "CONFIDENCE_VERY_HIGH", 
    "CONFIDENCE_HIGH", 
    "CONFIDENCE_PROBABLE", 
    "CONFIDENCE_LOW", 
    "CONFIDENCE_NONE"
  ], 
  "id": "ALBAppLearningConfidenceLabel", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AppLearningConfidenceLabel type", 
  "type": "string"
}

ALBAppLearningConfidenceOverride (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AppLearningConfidenceOverride object", 
  "id": "ALBAppLearningConfidenceOverride", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "confid_high_value": {
      "default": 9500, 
      "description": "Confidence threshold for label CONFIDENCE_HIGH. Default value when not specified in API or module is interpreted by ALB Controller as 9500.", 
      "required": false, 
      "title": "Confid high value", 
      "type": "integer"
    }, 
    "confid_low_value": {
      "default": 7500, 
      "description": "Confidence threshold for label CONFIDENCE_LOW. Default value when not specified in API or module is interpreted by ALB Controller as 7500.", 
      "required": false, 
      "title": "Confid low value", 
      "type": "integer"
    }, 
    "confid_probable_value": {
      "default": 9000, 
      "description": "Confidence threshold for label CONFIDENCE_PROBABLE. Default value when not specified in API or module is interpreted by ALB Controller as 9000.", 
      "required": false, 
      "title": "Confid probable value", 
      "type": "integer"
    }, 
    "confid_very_high_value": {
      "default": 9999, 
      "description": "Confidence threshold for label CONFIDENCE_VERY_HIGH. Default value when not specified in API or module is interpreted by ALB Controller as 9999.", 
      "required": false, 
      "title": "Confid very high value", 
      "type": "integer"
    }
  }, 
  "title": "AppLearningConfidenceOverride", 
  "type": "object"
}

ALBAppLearningParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AppLearningParams object", 
  "id": "ALBAppLearningParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable_per_uri_learning": {
      "default": true, 
      "description": "Learn the params per URI path. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable per uri learning", 
      "type": "boolean"
    }, 
    "max_params": {
      "default": 100, 
      "description": "Maximum number of params to learn for an application. Allowed values are 10-1000. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 1000, 
      "minimum": 10, 
      "required": false, 
      "title": "Max params", 
      "type": "integer"
    }, 
    "max_uris": {
      "default": 500, 
      "description": "Maximum number of URI paths to learn for an application. Allowed values are 10-10000. Default value when not specified in API or module is interpreted by ALB Controller as 500.", 
      "maximum": 10000, 
      "minimum": 10, 
      "required": false, 
      "title": "Max uris", 
      "type": "integer"
    }, 
    "min_hits_to_learn": {
      "default": 10000, 
      "description": "Minimum number of occurances required for a Param to qualify for learning. Default value when not specified in API or module is interpreted by ALB Controller as 10000.", 
      "required": false, 
      "title": "Min hits to learn", 
      "type": "integer"
    }, 
    "sampling_percent": {
      "default": 1, 
      "description": "Percent of the requests subjected to Application learning. Allowed values are 1-100. Unit is PERCENT. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Sampling percent", 
      "type": "integer"
    }, 
    "update_interval": {
      "default": 30, 
      "description": "Frequency with which SE publishes Application learning data to controller. Allowed values are 1-60. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "maximum": 60, 
      "minimum": 1, 
      "required": false, 
      "title": "Update interval", 
      "type": "integer"
    }
  }, 
  "title": "AppLearningParams", 
  "type": "object"
}

ALBApplicationPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ApplicationPersistenceProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBApplicationPersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "app_cookie_persistence_profile": {
      "$ref": "ALBAppCookiePersistenceProfile, 
      "description": "Specifies the Application Cookie Persistence profile parameters.", 
      "required": false, 
      "title": "App cookie persistence profile"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "hdr_persistence_profile": {
      "$ref": "ALBHdrPersistenceProfile, 
      "description": "Specifies the custom HTTP Header Persistence profile parameters.", 
      "required": false, 
      "title": "Hdr persistence profile"
    }, 
    "http_cookie_persistence_profile": {
      "$ref": "ALBHttpCookiePersistenceProfile, 
      "description": "Specifies the HTTP Cookie Persistence profile parameters.", 
      "required": false, 
      "title": "Http cookie persistence profile"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_persistence_profile": {
      "$ref": "ALBIPPersistenceProfile, 
      "description": "Specifies the Client IP Persistence profile parameters.", 
      "required": false, 
      "title": "Ip persistence profile"
    }, 
    "is_federated": {
      "default": false, 
      "description": "This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is federated", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "persistence_type": {
      "$ref": "ALBPersistenceProfileType, 
      "default": "PERSISTENCE_TYPE_CLIENT_IP_ADDRESS", 
      "description": "Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Basic(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Essentials(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS.", 
      "required": true, 
      "title": "Persistence type"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server_hm_down_recovery": {
      "$ref": "ALBPersistentServerHMDownRecovery, 
      "default": "HM_DOWN_PICK_NEW_SERVER", 
      "description": "Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Basic(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Essentials(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as HM_DOWN_PICK_NEW_SERVER.", 
      "required": false, 
      "title": "Server hm down recovery"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "ApplicationPersistenceProfile", 
  "type": "object"
}

ALBApplicationPersistenceProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ApplicationPersistenceProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBApplicationPersistenceProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ApplicationPersistenceProfile", 
      "items": {
        "$ref": "ALBApplicationPersistenceProfile
      }, 
      "required": false, 
      "title": "Array of ApplicationPersistenceProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ApplicationPersistenceProfileApiResponse", 
  "type": "object"
}

ALBApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ApplicationProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of application profiles. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "created_by": {
      "description": "Name of the application profile creator.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "dns_service_profile": {
      "$ref": "ALBDnsServiceApplicationProfile, 
      "description": "Specifies various DNS service related controls for virtual service.", 
      "required": false, 
      "title": "Dns service profile"
    }, 
    "dos_rl_profile": {
      "$ref": "ALBDosRateLimitProfile, 
      "description": "Specifies various security related controls for virtual service.", 
      "required": false, 
      "title": "Dos rl profile"
    }, 
    "http_profile": {
      "$ref": "ALBHTTPApplicationProfile, 
      "description": "Specifies the HTTP application proxy profile parameters.", 
      "required": false, 
      "title": "Http profile"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "preserve_client_ip": {
      "default": false, 
      "description": "Specifies if client IP needs to be preserved for backend connection. Not compatible with Connection Multiplexing. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Preserve client ip", 
      "type": "boolean"
    }, 
    "preserve_client_port": {
      "default": false, 
      "description": "Specifies if we need to preserve client port while preserving client IP for backend connections. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Preserve client port", 
      "type": "boolean"
    }, 
    "preserve_dest_ip_port": {
      "default": false, 
      "description": "Specifies if destination IP and port needs to be preserved for backend connection. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Preserve dest ip port", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sip_service_profile": {
      "$ref": "ALBSipServiceApplicationProfile, 
      "description": "Specifies various SIP service related controls for virtual service. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Sip service profile"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_app_profile": {
      "$ref": "ALBTCPApplicationProfile, 
      "description": "Specifies the TCP application proxy profile parameters.", 
      "required": false, 
      "title": "Tcp app profile"
    }, 
    "type": {
      "$ref": "ALBApplicationProfileType, 
      "description": "Specifies which application layer proxy is enabled for the virtual service. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Allowed in Basic(Allowed values- APPLICATION_PROFILE_TYPE_L4,APPLICATION_PROFILE_TYPE_HTTP) edition, Essentials(Allowed values- APPLICATION_PROFILE_TYPE_L4) edition, Enterprise edition.", 
      "required": true, 
      "title": "Type"
    }, 
    "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": "ApplicationProfile", 
  "type": "object"
}

ALBApplicationProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ApplicationProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBApplicationProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ApplicationProfile", 
      "items": {
        "$ref": "ALBApplicationProfile
      }, 
      "required": false, 
      "title": "Array of ApplicationProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ApplicationProfileApiResponse", 
  "type": "object"
}

ALBApplicationProfileType (type)

{
  "description": "Valid ENUM values for ALBApplicationProfileType", 
  "enum": [
    "APPLICATION_PROFILE_TYPE_L4", 
    "APPLICATION_PROFILE_TYPE_HTTP", 
    "APPLICATION_PROFILE_TYPE_SYSLOG", 
    "APPLICATION_PROFILE_TYPE_DNS", 
    "APPLICATION_PROFILE_TYPE_SSL", 
    "APPLICATION_PROFILE_TYPE_SIP"
  ], 
  "id": "ALBApplicationProfileType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ApplicationProfileType type", 
  "type": "string"
}

ALBAttackMitigationAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AttackMitigationAction object", 
  "id": "ALBAttackMitigationAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "deny": {
      "default": true, 
      "description": "Deny the attack packets further processing and drop them. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Deny", 
      "type": "boolean"
    }
  }, 
  "title": "AttackMitigationAction", 
  "type": "object"
}

ALBAttackType (type)

{
  "description": "Valid ENUM values for ALBAttackType", 
  "enum": [
    "LAND", 
    "SMURF", 
    "ICMP_PING_FLOOD", 
    "UNKOWN_PROTOCOL", 
    "TEARDROP", 
    "IP_FRAG_OVERRUN", 
    "IP_FRAG_TOOSMALL", 
    "IP_FRAG_FULL", 
    "IP_FRAG_INCOMPLETE", 
    "PORT_SCAN", 
    "TCP_NON_SYN_FLOOD_OLD", 
    "SYN_FLOOD", 
    "BAD_RST_FLOOD", 
    "MALFORMED_FLOOD", 
    "FAKE_SESSION", 
    "ZERO_WINDOW_STRESS", 
    "SMALL_WINDOW_STRESS", 
    "DOS_HTTP_TIMEOUT", 
    "DOS_HTTP_ERROR", 
    "DOS_HTTP_ABORT", 
    "DOS_SSL_ERROR", 
    "DOS_APP_ERROR", 
    "DOS_REQ_IP_RL_DROP", 
    "DOS_REQ_URI_RL_DROP", 
    "DOS_REQ_URI_SCAN_BAD_RL_DROP", 
    "DOS_REQ_URI_SCAN_UNKNOWN_RL_DROP", 
    "DOS_REQ_IP_URI_RL_DROP", 
    "DOS_CONN_IP_RL_DROP", 
    "DOS_SLOW_URL", 
    "TCP_NON_SYN_FLOOD", 
    "DOS_REQ_CIP_SCAN_BAD_RL_DROP", 
    "DOS_REQ_CIP_SCAN_UNKNOWN_RL_DROP", 
    "DOS_REQ_IP_RL_DROP_BAD", 
    "DOS_REQ_URI_RL_DROP_BAD", 
    "DOS_REQ_IP_URI_RL_DROP_BAD", 
    "POLICY_DROPS", 
    "DOS_CONN_RL_DROP", 
    "DOS_REQ_RL_DROP", 
    "DOS_REQ_HDR_RL_DROP", 
    "DOS_REQ_CUSTOM_RL_DROP", 
    "DNS_ATTACK_REFLECTION"
  ], 
  "id": "ALBAttackType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AttackType type", 
  "type": "string"
}

ALBAuthAttributeMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthAttributeMatch object", 
  "id": "ALBAuthAttributeMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "attribute_name": {
      "description": "Attribute name whose values will be looked up in the access lists.", 
      "required": true, 
      "title": "Attribute name", 
      "type": "string"
    }, 
    "attribute_value_list": {
      "$ref": "ALBStringMatch, 
      "description": "Attribute Values used to determine access when authentication applies. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": true, 
      "title": "Attribute value list"
    }
  }, 
  "title": "AuthAttributeMatch", 
  "type": "object"
}

ALBAuthLdapSearchScope (type)

{
  "description": "Valid ENUM values for ALBAuthLdapSearchScope", 
  "enum": [
    "AUTH_LDAP_SCOPE_BASE", 
    "AUTH_LDAP_SCOPE_ONE", 
    "AUTH_LDAP_SCOPE_SUBTREE"
  ], 
  "id": "ALBAuthLdapSearchScope", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthLdapSearchScope type", 
  "type": "string"
}

ALBAuthLdapSecurityMode (type)

{
  "description": "Valid ENUM values for ALBAuthLdapSecurityMode", 
  "enum": [
    "AUTH_LDAP_SECURE_NONE", 
    "AUTH_LDAP_SECURE_USE_LDAPS"
  ], 
  "id": "ALBAuthLdapSecurityMode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthLdapSecurityMode type", 
  "type": "string"
}

ALBAuthProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBAuthProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "http": {
      "$ref": "ALBAuthProfileHTTPClientParams, 
      "description": "HTTP user authentication params.", 
      "required": false, 
      "title": "Http"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap": {
      "$ref": "ALBLdapAuthSettings, 
      "description": "LDAP server and directory settings.", 
      "required": false, 
      "title": "Ldap"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "saml": {
      "$ref": "ALBSamlSettings, 
      "description": "SAML settings.", 
      "required": false, 
      "title": "Saml"
    }, 
    "tacacs_plus": {
      "$ref": "ALBTacacsPlusAuthSettings, 
      "description": "TACACS+ settings.", 
      "required": false, 
      "title": "Tacacs plus"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBAuthProfileType, 
      "description": "Type of the Auth Profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT.", 
      "required": true, 
      "title": "Type"
    }, 
    "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": "AuthProfile", 
  "type": "object"
}

ALBAuthProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "AuthProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBAuthProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of AuthProfile", 
      "items": {
        "$ref": "ALBAuthProfile
      }, 
      "required": false, 
      "title": "Array of AuthProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AuthProfileApiResponse", 
  "type": "object"
}

ALBAuthProfileHTTPClientParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthProfileHTTPClientParams object", 
  "id": "ALBAuthProfileHTTPClientParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cache_expiration_time": {
      "default": 5, 
      "description": "The max allowed length of time a clients authentication is cached. Allowed values are 1-30. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 5.", 
      "maximum": 30, 
      "minimum": 1, 
      "required": false, 
      "title": "Cache expiration time", 
      "type": "integer"
    }, 
    "request_header": {
      "description": "Insert an HTTP header. This field is used to define the header name. The value of the header is set to the client's HTTP Auth user ID.", 
      "required": false, 
      "title": "Request header", 
      "type": "string"
    }, 
    "require_user_groups": {
      "description": "A user should be a member of these groups. Each group is defined by the DN. For example, CN=testgroup,OU=groups,dc=example,dc=avinetworks,DC=com.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Require user groups", 
      "type": "array"
    }
  }, 
  "title": "AuthProfileHTTPClientParams", 
  "type": "object"
}

ALBAuthProfileType (type)

{
  "description": "Valid ENUM values for ALBAuthProfileType", 
  "enum": [
    "AUTH_PROFILE_LDAP", 
    "AUTH_PROFILE_TACACS_PLUS", 
    "AUTH_PROFILE_SAML", 
    "AUTH_PROFILE_PINGACCESS", 
    "AUTH_PROFILE_JWT"
  ], 
  "id": "ALBAuthProfileType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthProfileType type", 
  "type": "string"
}

ALBAuthSamlEntityType (type)

{
  "description": "Valid ENUM values for ALBAuthSamlEntityType", 
  "enum": [
    "AUTH_SAML_CLUSTER_VIP", 
    "AUTH_SAML_DNS_FQDN", 
    "AUTH_SAML_APP_VS"
  ], 
  "id": "ALBAuthSamlEntityType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthSamlEntityType type", 
  "type": "string"
}

ALBAuthTacacsPlusAttributeValuePair (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthTacacsPlusAttributeValuePair object", 
  "id": "ALBAuthTacacsPlusAttributeValuePair", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "mandatory": {
      "description": "mandatory.", 
      "required": false, 
      "title": "Mandatory", 
      "type": "boolean"
    }, 
    "name": {
      "description": "attribute name.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "value": {
      "description": "attribute value.", 
      "required": false, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "AuthTacacsPlusAttributeValuePair", 
  "type": "object"
}

ALBAuthTacacsPlusService (type)

{
  "description": "Valid ENUM values for ALBAuthTacacsPlusService", 
  "enum": [
    "AUTH_TACACS_PLUS_SERVICE_NONE", 
    "AUTH_TACACS_PLUS_SERVICE_LOGIN", 
    "AUTH_TACACS_PLUS_SERVICE_ENABLE", 
    "AUTH_TACACS_PLUS_SERVICE_PPP", 
    "AUTH_TACACS_PLUS_SERVICE_ARAP", 
    "AUTH_TACACS_PLUS_SERVICE_PT", 
    "AUTH_TACACS_PLUS_SERVICE_RCMD", 
    "AUTH_TACACS_PLUS_SERVICE_X25", 
    "AUTH_TACACS_PLUS_SERVICE_NASI", 
    "AUTH_TACACS_PLUS_SERVICE_FWPROXY"
  ], 
  "id": "ALBAuthTacacsPlusService", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthTacacsPlusService type", 
  "type": "string"
}

ALBAuthToken (type)

{
  "description": "ALB Auth Token", 
  "id": "ALBAuthToken", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "expires_at": {
      "description": "Expiry time of the token will be set by LCM at the time of Enforcement Point Creation.", 
      "required": false, 
      "title": "Expiry time of the token", 
      "type": "string"
    }, 
    "hours": {
      "description": "Hours to validate the token", 
      "required": true, 
      "title": "hours", 
      "type": "string"
    }, 
    "token": {
      "description": "Token for Avi Controller.", 
      "title": "Token for Avi Controller", 
      "type": "string"
    }, 
    "username": {
      "description": "controller username.", 
      "required": true, 
      "title": "username", 
      "type": "string"
    }
  }, 
  "title": "Auth Token", 
  "type": "object"
}

ALBAuthenticationAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthenticationAction object", 
  "id": "ALBAuthenticationAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "type": {
      "$ref": "ALBAuthenticationActionEnum, 
      "default": "USE_DEFAULT_AUTHENTICATION", 
      "description": "Authentication Action to be taken for a matched Rule. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Default value when not specified in API or module is interpreted by ALB Controller as USE_DEFAULT_AUTHENTICATION.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "AuthenticationAction", 
  "type": "object"
}

ALBAuthenticationActionEnum (type)

{
  "description": "Valid ENUM values for ALBAuthenticationActionEnum", 
  "enum": [
    "SKIP_AUTHENTICATION", 
    "USE_DEFAULT_AUTHENTICATION"
  ], 
  "id": "ALBAuthenticationActionEnum", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthenticationActionEnum type", 
  "type": "string"
}

ALBAuthenticationMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthenticationMatch object", 
  "id": "ALBAuthenticationMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Configure client ip addresses.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "host_hdr": {
      "$ref": "ALBHostHdrMatch, 
      "description": "Configure the host header.", 
      "required": false, 
      "title": "Host hdr"
    }, 
    "path": {
      "$ref": "ALBPathMatch, 
      "description": "Configure request paths.", 
      "required": false, 
      "title": "Path"
    }
  }, 
  "title": "AuthenticationMatch", 
  "type": "object"
}

ALBAuthenticationPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthenticationPolicy object", 
  "id": "ALBAuthenticationPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "authn_rules": {
      "description": "Add rules to apply auth profile to specific targets.", 
      "items": {
        "$ref": "ALBAuthenticationRule
      }, 
      "required": false, 
      "title": "Authn rules", 
      "type": "array"
    }, 
    "default_auth_profile_path": {
      "description": "Auth Profile to use for validating users. It is a reference to an object of type AuthProfile.", 
      "required": true, 
      "title": "Default auth profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBSSOPolicy"
          ], 
          "relationshipType": "ALB_SSOPOLICY_ALB_AUTHPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBAuthProfile"
          ]
        }
      ]
    }
  }, 
  "title": "AuthenticationPolicy", 
  "type": "object"
}

ALBAuthenticationRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthenticationRule object", 
  "id": "ALBAuthenticationRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBAuthenticationAction, 
      "description": "Enable or disable authentication for matched targets.", 
      "required": false, 
      "title": "Action"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBAuthenticationMatch, 
      "description": "Add match criteria to the rule. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "AuthenticationRule", 
  "type": "object"
}

ALBAuthorizationAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthorizationAction object", 
  "id": "ALBAuthorizationAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "status_code": {
      "$ref": "ALBAuthorizationActionHttpStatusCode, 
      "description": "HTTP status code to use for local response when an policy rule is matched. Enum options - HTTP_RESPONSE_STATUS_CODE_401, HTTP_RESPONSE_STATUS_CODE_403.", 
      "required": false, 
      "title": "Status code"
    }, 
    "type": {
      "$ref": "ALBAuthorizationActionEnum, 
      "default": "ALLOW_ACCESS", 
      "description": "Defines the action taken when an authorization policy rule is matched. By default, access is allowed to the requested resource. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Default value when not specified in API or module is interpreted by ALB Controller as ALLOW_ACCESS.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "AuthorizationAction", 
  "type": "object"
}

ALBAuthorizationActionEnum (type)

{
  "description": "Valid ENUM values for ALBAuthorizationActionEnum", 
  "enum": [
    "ALLOW_ACCESS", 
    "CLOSE_CONNECTION", 
    "HTTP_LOCAL_RESPONSE"
  ], 
  "id": "ALBAuthorizationActionEnum", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthorizationActionEnum type", 
  "type": "string"
}

ALBAuthorizationActionHttpStatusCode (type)

{
  "description": "Valid ENUM values for ALBAuthorizationActionHttpStatusCode", 
  "enum": [
    "HTTP_RESPONSE_STATUS_CODE_401", 
    "HTTP_RESPONSE_STATUS_CODE_403"
  ], 
  "id": "ALBAuthorizationActionHttpStatusCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "AuthorizationActionHttpStatusCode type", 
  "type": "string"
}

ALBAuthorizationMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthorizationMatch object", 
  "id": "ALBAuthorizationMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "attr_matches": {
      "description": "Attributes whose values need to be matched. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBAuthAttributeMatch
      }, 
      "required": false, 
      "title": "Attr matches", 
      "type": "array"
    }, 
    "host_hdr": {
      "$ref": "ALBHostHdrMatch, 
      "description": "Host header value to be matched.", 
      "required": false, 
      "title": "Host hdr"
    }, 
    "method": {
      "$ref": "ALBMethodMatch, 
      "description": "HTTP methods to be matched.", 
      "required": false, 
      "title": "Method"
    }, 
    "path": {
      "$ref": "ALBPathMatch, 
      "description": "Paths/URLs to be matched.", 
      "required": false, 
      "title": "Path"
    }
  }, 
  "title": "AuthorizationMatch", 
  "type": "object"
}

ALBAuthorizationPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthorizationPolicy object", 
  "id": "ALBAuthorizationPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "authz_rules": {
      "description": "Authorization Policy Rules.", 
      "items": {
        "$ref": "ALBAuthorizationRule
      }, 
      "required": false, 
      "title": "Authz rules", 
      "type": "array"
    }
  }, 
  "title": "AuthorizationPolicy", 
  "type": "object"
}

ALBAuthorizationRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AuthorizationRule object", 
  "id": "ALBAuthorizationRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBAuthorizationAction, 
      "description": "Authorization action when rule is matched.", 
      "required": true, 
      "title": "Action"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the Authorization Policy rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBAuthorizationMatch, 
      "description": "Authorization match criteria for the rule. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": true, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "AuthorizationRule", 
  "type": "object"
}

ALBAutoScaleLaunchConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AutoScaleLaunchConfig object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBAutoScaleLaunchConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "image_id": {
      "description": "Unique ID of the Amazon Machine Image (AMI)  or OpenStack VM ID.", 
      "required": false, 
      "title": "Image id", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "mesos": {
      "$ref": "ALBAutoScaleMesosSettings, 
      "description": "Placeholder for description of property mesos of obj type AutoScaleLaunchConfig field type str  type ref.", 
      "required": false, 
      "title": "Mesos"
    }, 
    "openstack": {
      "$ref": "ALBAutoScaleOpenStackSettings, 
      "description": "Placeholder for description of property openstack of obj type AutoScaleLaunchConfig field type str  type ref.", 
      "required": false, 
      "title": "Openstack"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "use_external_asg": {
      "default": true, 
      "description": "If set to True, ServerAutoscalePolicy will use the autoscaling group (external_autoscaling_groups) from Pool to perform scale up and scale down. Pool should have single autoscaling group configured. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Use external asg", 
      "type": "boolean"
    }
  }, 
  "title": "AutoScaleLaunchConfig", 
  "type": "object"
}

ALBAutoScaleLaunchConfigApiResponse (type)

{
  "additionalProperties": false, 
  "description": "AutoScaleLaunchConfigApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBAutoScaleLaunchConfigApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of AutoScaleLaunchConfig", 
      "items": {
        "$ref": "ALBAutoScaleLaunchConfig
      }, 
      "required": false, 
      "title": "Array of AutoScaleLaunchConfig", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AutoScaleLaunchConfigApiResponse", 
  "type": "object"
}

ALBAutoScaleMesosSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AutoScaleMesosSettings object", 
  "id": "ALBAutoScaleMesosSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "force": {
      "default": true, 
      "description": "Apply scaleout even when there are deployments inprogress. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Force", 
      "type": "boolean"
    }
  }, 
  "title": "AutoScaleMesosSettings", 
  "type": "object"
}

ALBAutoScaleOpenStackSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer AutoScaleOpenStackSettings object", 
  "id": "ALBAutoScaleOpenStackSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "heat_scale_down_url": {
      "description": "Avi Controller will use this URL to scale downthe pool. Cloud connector will automatically update the membership. This is an alpha feature.", 
      "required": false, 
      "title": "Heat scale down url", 
      "type": "string"
    }, 
    "heat_scale_up_url": {
      "description": "Avi Controller will use this URL to scale upthe pool. Cloud connector will automatically update the membership. This is an alpha feature.", 
      "required": false, 
      "title": "Heat scale up url", 
      "type": "string"
    }
  }, 
  "title": "AutoScaleOpenStackSettings", 
  "type": "object"
}

ALBCRL (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CRL object", 
  "id": "ALBCRL", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "body": {
      "description": "Certificate Revocation list from a given issuer in PEM format. This can either be configured directly or via the server_url.", 
      "required": false, 
      "title": "Body", 
      "type": "string"
    }, 
    "common_name": {
      "description": "Common name of the issuer in the Certificate Revocation list.", 
      "required": false, 
      "title": "Common name", 
      "type": "string"
    }, 
    "distinguished_name": {
      "description": "Distinguished name of the issuer in the Certificate Revocation list.", 
      "required": false, 
      "title": "Distinguished name", 
      "type": "string"
    }, 
    "etag": {
      "description": "Cached etag to optimize the download of the CRL.", 
      "required": false, 
      "title": "Etag", 
      "type": "string"
    }, 
    "fingerprint": {
      "description": "Fingerprint of the CRL. Used to avoid configuring duplicates.", 
      "required": false, 
      "title": "Fingerprint", 
      "type": "string"
    }, 
    "last_refreshed": {
      "description": "Last time CRL was refreshed by the system. This is an internal field used by the system.", 
      "required": false, 
      "title": "Last refreshed", 
      "type": "string"
    }, 
    "last_update": {
      "description": "The date when this CRL was last issued.", 
      "required": false, 
      "title": "Last update", 
      "type": "string"
    }, 
    "next_update": {
      "description": "The date when a newer CRL will be available. Also conveys the date after which the CRL should be considered obsolete.", 
      "required": false, 
      "title": "Next update", 
      "type": "string"
    }, 
    "server_url": {
      "description": "URL of a server that issues the Certificate Revocation list. If this is configured, CRL will be periodically downloaded either based on the configured update interval or the next update interval in the CRL. CRL itself is stored in the body.", 
      "required": false, 
      "title": "Server url", 
      "type": "string"
    }, 
    "text": {
      "description": "Certificate Revocation list in plain text for readability.", 
      "required": false, 
      "title": "Text", 
      "type": "string"
    }, 
    "update_interval": {
      "description": "Interval in minutes to check for CRL update. If not specified, interval will be 1 day. Allowed values are 30-525600. Unit is MIN.", 
      "maximum": 525600, 
      "minimum": 30, 
      "required": false, 
      "title": "Update interval", 
      "type": "integer"
    }
  }, 
  "title": "CRL", 
  "type": "object"
}

ALBCertificateAuthority (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CertificateAuthority object", 
  "id": "ALBCertificateAuthority", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ca_path": {
      "description": "It is a reference to an object of type SSLKeyAndCertificate.", 
      "required": false, 
      "title": "Ca path", 
      "type": "string"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "CertificateAuthority", 
  "type": "object"
}

ALBCertificateManagementProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CertificateManagementProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBCertificateManagementProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "script_params": {
      "description": "Placeholder for description of property script_params of obj type CertificateManagementProfile field type str  type array.", 
      "items": {
        "$ref": "ALBCustomParams
      }, 
      "required": false, 
      "title": "Script params", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "CertificateManagementProfile", 
  "type": "object"
}

ALBClientInsights (type)

{
  "description": "Valid ENUM values for ALBClientInsights", 
  "enum": [
    "NO_INSIGHTS", 
    "PASSIVE", 
    "ACTIVE"
  ], 
  "id": "ALBClientInsights", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ClientInsights type", 
  "type": "string"
}

ALBClientInsightsSampling (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ClientInsightsSampling object", 
  "id": "ALBClientInsightsSampling", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Client IP addresses to check when inserting RUM script.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "sample_uris": {
      "$ref": "ALBStringMatch, 
      "description": "URL patterns to check when inserting RUM script.", 
      "required": false, 
      "title": "Sample uris"
    }, 
    "skip_uris": {
      "$ref": "ALBStringMatch, 
      "description": "URL patterns to avoid when inserting RUM script.", 
      "required": false, 
      "title": "Skip uris"
    }
  }, 
  "title": "ClientInsightsSampling", 
  "type": "object"
}

ALBClientLogConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ClientLogConfiguration object", 
  "id": "ALBClientLogConfiguration", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable_significant_log_collection": {
      "default": false, 
      "description": "Enable significant log collection. By default, this flag is enabled, which means that Avi SEs collect significant logs and forward them to Controller for further processing. For example, these logs correspond to error conditions such as when the response code for a request is 500. Users can deactivate this flag to turn off default significant log collection. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable significant log collection", 
      "type": "boolean"
    }, 
    "filtered_log_processing": {
      "$ref": "ALBLogsProcessingType, 
      "default": "LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND", 
      "description": "Filtered logs are logs that match any client log filters or rules with logging enabled. Such logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND.", 
      "required": false, 
      "title": "Filtered log processing"
    }, 
    "non_significant_log_processing": {
      "$ref": "ALBLogsProcessingType, 
      "default": "LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND", 
      "description": "Logs that are neither significant nor filtered, are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND.", 
      "required": false, 
      "title": "Non significant log processing"
    }, 
    "significant_log_processing": {
      "$ref": "ALBLogsProcessingType, 
      "default": "LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND", 
      "description": "Significant logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND.", 
      "required": false, 
      "title": "Significant log processing"
    }
  }, 
  "title": "ClientLogConfiguration", 
  "type": "object"
}

ALBClientLogFilter (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ClientLogFilter object", 
  "id": "ALBClientLogFilter", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "all_headers": {
      "default": false, 
      "description": "Placeholder for description of property all_headers of obj type ClientLogFilter field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "All headers", 
      "type": "boolean"
    }, 
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Placeholder for description of property client_ip of obj type ClientLogFilter field type str  type ref.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "duration": {
      "default": 30, 
      "description": "Special values are 0 - 'infinite'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "required": false, 
      "title": "Duration", 
      "type": "integer"
    }, 
    "enabled": {
      "default": false, 
      "description": "Placeholder for description of property enabled of obj type ClientLogFilter field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "uri": {
      "$ref": "ALBStringMatch, 
      "description": "Placeholder for description of property uri of obj type ClientLogFilter field type str  type ref.", 
      "required": false, 
      "title": "Uri"
    }
  }, 
  "title": "ClientLogFilter", 
  "type": "object"
}

ALBClientLogStreamingConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ClientLogStreamingConfig object", 
  "id": "ALBClientLogStreamingConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "external_server": {
      "description": "IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4. Optionally, a separate port can be specified for each external server in the list, for example, 11.11.11.11 234,12.12.12.12 343.", 
      "required": true, 
      "title": "External server", 
      "type": "string"
    }, 
    "external_server_port": {
      "default": 514, 
      "description": "The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Default value when not specified in API or module is interpreted by ALB Controller as 514.", 
      "required": false, 
      "title": "External server port", 
      "type": "integer"
    }, 
    "format_config": {
      "$ref": "ALBClientLogStreamingFormat, 
      "description": "Configuration to specify the format of streamed logs. By default, each log is encoded in JSON format.", 
      "required": false, 
      "title": "Format config"
    }, 
    "log_types_to_send": {
      "$ref": "ALBLogsType, 
      "default": "LOGS_ALL", 
      "description": "Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Default value when not specified in API or module is interpreted by ALB Controller as LOGS_ALL.", 
      "required": false, 
      "title": "Log types to send"
    }, 
    "max_logs_per_second": {
      "default": 100, 
      "description": "Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "required": false, 
      "title": "Max logs per second", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "ALBClientLogStreamingProtocol, 
      "default": "LOG_STREAMING_PROTOCOL_UDP", 
      "description": "Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Default value when not specified in API or module is interpreted by ALB Controller as LOG_STREAMING_PROTOCOL_UDP.", 
      "required": false, 
      "title": "Protocol"
    }, 
    "syslog_config": {
      "$ref": "ALBStreamingSyslogConfig, 
      "description": "Syslog configuration if a Syslog-based protocol is specified for streaming.", 
      "required": false, 
      "title": "Syslog config"
    }
  }, 
  "title": "ClientLogStreamingConfig", 
  "type": "object"
}

ALBClientLogStreamingFormat (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ClientLogStreamingFormat object", 
  "id": "ALBClientLogStreamingFormat", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "format": {
      "$ref": "ALBLogStreamingFormatType, 
      "description": "Format for the streamed logs. Enum options - LOG_STREAMING_FORMAT_JSON_FULL, LOG_STREAMING_FORMAT_JSON_SELECTED.", 
      "required": true, 
      "title": "Format"
    }, 
    "included_fields": {
      "description": "List of log fields to be streamed, when selective fields (LOG_STREAMING_FORMAT_JSON_SELECTED) option is chosen. Only top-level fields in application or connection logs are supported.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Included fields", 
      "type": "array"
    }
  }, 
  "title": "ClientLogStreamingFormat", 
  "type": "object"
}

ALBClientLogStreamingProtocol (type)

{
  "description": "Valid ENUM values for ALBClientLogStreamingProtocol", 
  "enum": [
    "LOG_STREAMING_PROTOCOL_UDP", 
    "LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP", 
    "LOG_STREAMING_PROTOCOL_TCP", 
    "LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP", 
    "LOG_STREAMING_PROTOCOL_RAW_OVER_UDP", 
    "LOG_STREAMING_PROTOCOL_TLS", 
    "LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS"
  ], 
  "id": "ALBClientLogStreamingProtocol", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ClientLogStreamingProtocol type", 
  "type": "string"
}

ALBCloneServer (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CloneServer object", 
  "id": "ALBCloneServer", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip_address": {
      "$ref": "ALBIpAddr, 
      "description": "IP Address of the Clone Server.", 
      "required": false, 
      "title": "Ip address"
    }, 
    "mac": {
      "description": "MAC Address of the Clone Server.", 
      "required": false, 
      "title": "Mac", 
      "type": "string"
    }, 
    "network_name": {
      "description": "Network to clone the traffic to. It is a reference to an object of type Network.", 
      "required": false, 
      "title": "Network name", 
      "type": "string"
    }, 
    "subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Subnet of the network to clone the traffic to.", 
      "required": false, 
      "title": "Subnet"
    }
  }, 
  "title": "CloneServer", 
  "type": "object"
}

ALBCloudType (type)

{
  "description": "Valid ENUM values for ALBCloudType", 
  "enum": [
    "CLOUD_NONE", 
    "CLOUD_VCENTER", 
    "CLOUD_OPENSTACK", 
    "CLOUD_AWS", 
    "CLOUD_VCA", 
    "CLOUD_APIC", 
    "CLOUD_MESOS", 
    "CLOUD_LINUXSERVER", 
    "CLOUD_DOCKER_UCP", 
    "CLOUD_RANCHER", 
    "CLOUD_OSHIFT_K8S", 
    "CLOUD_AZURE", 
    "CLOUD_GCP", 
    "CLOUD_NSXT"
  ], 
  "id": "ALBCloudType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "CloudType type", 
  "type": "string"
}

ALBComparisonOperator (type)

{
  "description": "Valid ENUM values for ALBComparisonOperator", 
  "enum": [
    "CO_EQ", 
    "CO_GT", 
    "CO_GE", 
    "CO_LT", 
    "CO_LE", 
    "CO_NE"
  ], 
  "id": "ALBComparisonOperator", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ComparisonOperator type", 
  "type": "string"
}

ALBCompressionFilter (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CompressionFilter object", 
  "id": "ALBCompressionFilter", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "devices_path": {
      "description": "It is a reference to an object of type StringGroup.", 
      "required": false, 
      "title": "Devices path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "ip_addr_prefixes": {
      "description": "Placeholder for description of property ip_addr_prefixes of obj type CompressionFilter field type str  type array.", 
      "items": {
        "$ref": "ALBIpAddrPrefix
      }, 
      "required": false, 
      "title": "Ip addr prefixes", 
      "type": "array"
    }, 
    "ip_addr_ranges": {
      "description": "Placeholder for description of property ip_addr_ranges of obj type CompressionFilter field type str  type array.", 
      "items": {
        "$ref": "ALBIpAddrRange
      }, 
      "required": false, 
      "title": "Ip addr ranges", 
      "type": "array"
    }, 
    "ip_addrs": {
      "description": "Placeholder for description of property ip_addrs of obj type CompressionFilter field type str  type array.", 
      "items": {
        "$ref": "ALBIpAddr
      }, 
      "required": false, 
      "title": "Ip addrs", 
      "type": "array"
    }, 
    "ip_addrs_path": {
      "description": "It is a reference to an object of type IpAddrGroup.", 
      "required": false, 
      "title": "Ip addrs path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }
      ]
    }, 
    "level": {
      "$ref": "ALBCompressionFilterLevel, 
      "default": "NORMAL_COMPRESSION", 
      "description": "Enum options - AGGRESSIVE_COMPRESSION, NORMAL_COMPRESSION, NO_COMPRESSION. Default value when not specified in API or module is interpreted by ALB Controller as NORMAL_COMPRESSION.", 
      "required": true, 
      "title": "Level"
    }, 
    "match": {
      "$ref": "ALBMatchOperation, 
      "default": "IS_IN", 
      "description": "Whether to apply Filter when group criteria is matched or not. Enum options - IS_IN, IS_NOT_IN. Default value when not specified in API or module is interpreted by ALB Controller as IS_IN.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "user_agent": {
      "description": "Placeholder for description of property user_agent of obj type CompressionFilter field type str  type array.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "User agent", 
      "type": "array"
    }
  }, 
  "title": "CompressionFilter", 
  "type": "object"
}

ALBCompressionFilterLevel (type)

{
  "description": "Valid ENUM values for ALBCompressionFilterLevel", 
  "enum": [
    "AGGRESSIVE_COMPRESSION", 
    "NORMAL_COMPRESSION", 
    "NO_COMPRESSION"
  ], 
  "id": "ALBCompressionFilterLevel", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "CompressionFilterLevel type", 
  "type": "string"
}

ALBCompressionProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CompressionProfile object", 
  "id": "ALBCompressionProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "compressible_content_path": {
      "description": "Compress only content types listed in this string group. Content types not present in this list are not compressed. It is a reference to an object of type StringGroup.", 
      "required": false, 
      "title": "Compressible content path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "compression": {
      "default": false, 
      "description": "Compress HTTP response content if it wasn't already compressed. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Compression", 
      "type": "boolean"
    }, 
    "filter": {
      "description": "Custom filters used when auto compression is not selected.", 
      "items": {
        "$ref": "ALBCompressionFilter
      }, 
      "required": false, 
      "title": "Filter", 
      "type": "array"
    }, 
    "remove_accept_encoding_header": {
      "default": true, 
      "description": "Offload compression from the servers to AVI. Saves compute cycles on the servers. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": true, 
      "title": "Remove accept encoding header", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "ALBCompressionType, 
      "default": "AUTO_COMPRESSION", 
      "description": "Compress content automatically or add custom filters to define compressible content and compression levels. Enum options - AUTO_COMPRESSION, CUSTOM_COMPRESSION. Default value when not specified in API or module is interpreted by ALB Controller as AUTO_COMPRESSION.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "CompressionProfile", 
  "type": "object"
}

ALBCompressionType (type)

{
  "description": "Valid ENUM values for ALBCompressionType", 
  "enum": [
    "AUTO_COMPRESSION", 
    "CUSTOM_COMPRESSION"
  ], 
  "id": "ALBCompressionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "CompressionType type", 
  "type": "string"
}

ALBCongestionAlgo (type)

{
  "description": "Valid ENUM values for ALBCongestionAlgo", 
  "enum": [
    "CC_ALGO_NEW_RENO", 
    "CC_ALGO_CUBIC", 
    "CC_ALGO_HTCP"
  ], 
  "id": "ALBCongestionAlgo", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "CongestionAlgo type", 
  "type": "string"
}

ALBConnPoolProperties (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ConnPoolProperties object", 
  "id": "ALBConnPoolProperties", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "upstream_connpool_conn_idle_tmo": {
      "default": 60000, 
      "description": "Connection idle timeout. Allowed in Basic(Allowed values- 60000) edition, Essentials(Allowed values- 60000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 60000.", 
      "required": false, 
      "title": "Upstream connpool conn idle tmo", 
      "type": "integer"
    }, 
    "upstream_connpool_conn_life_tmo": {
      "default": 600000, 
      "description": "Connection life timeout. Allowed in Basic(Allowed values- 600000) edition, Essentials(Allowed values- 600000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 600000.", 
      "required": false, 
      "title": "Upstream connpool conn life tmo", 
      "type": "integer"
    }, 
    "upstream_connpool_conn_max_reuse": {
      "default": 0, 
      "description": "Maximum number of times a connection can be reused. Special values are 0- 'unlimited'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Upstream connpool conn max reuse", 
      "type": "integer"
    }, 
    "upstream_connpool_server_max_cache": {
      "default": 0, 
      "description": "Maximum number of connections a server can cache. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Upstream connpool server max cache", 
      "type": "integer"
    }
  }, 
  "title": "ConnPoolProperties", 
  "type": "object"
}

ALBContentRewriteProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ContentRewriteProfile object", 
  "id": "ALBContentRewriteProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "response_rewrite_enabled": {
      "default": false, 
      "description": "Enable rewrite on response body. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Response rewrite enabled", 
      "type": "boolean"
    }, 
    "rewritable_content_path": {
      "description": "Rewrite only content types listed in this string group. Content types not present in this list are not rewritten. It is a reference to an object of type StringGroup.", 
      "required": false, 
      "title": "Rewritable content path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "rsp_match_replace_pair": {
      "description": "Strings to be matched and replaced with on the response body. This should be configured when response_rewrite_enabled is set to true.", 
      "items": {
        "$ref": "ALBMatchReplacePair
      }, 
      "required": false, 
      "title": "Rsp match replace pair", 
      "type": "array"
    }
  }, 
  "title": "ContentRewriteProfile", 
  "type": "object"
}

ALBControllerClusterInfo (type)

{
  "additionalProperties": false, 
  "description": "Advanced Load Balancer controller cluster information about nodes in the cluster and cluster information.", 
  "id": "ALBControllerClusterInfo", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "cluster_name": {
      "description": "Advanced Load Balancer controller cluster name.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller cluster name", 
      "type": "string"
    }, 
    "cluster_state": {
      "description": "Advanced Load Balancer controller cluster state.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller cluster state", 
      "type": "string"
    }, 
    "cluster_uuid": {
      "description": "ID of the Cluster maintained internally. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "title": "ID of the cluster used to recognize it", 
      "type": "string"
    }, 
    "error": {
      "$ref": "AlbControllerClusterRuntimeError, 
      "description": "Advanced Load Balancer controller cluster error information, if any.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller cluster error"
    }, 
    "nodes": {
      "items": {
        "$ref": "ALBControllerNodeInfo
      }, 
      "title": "Advanced Load Balancer controller node information", 
      "type": "array"
    }, 
    "reason": {
      "description": "Advanced Load Balancer cluster state not STABLE reason.", 
      "readonly": true, 
      "title": "Advanced Load Balancer cluster state not STABLE reason.", 
      "type": "string"
    }, 
    "version": {
      "description": "Advanced Load Balancer controller cluster version.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller cluster version", 
      "type": "string"
    }, 
    "virtual_ip": {
      "$ref": "IPAddress, 
      "description": "Advanced Load Balancer controller cluster virtual_ip.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller cluster VIP"
    }
  }, 
  "title": "Advanced Load Balancer controller cluster info", 
  "type": "object"
}

ALBControllerClusterNodeVMFormFactor (type)

{
  "description": "Specifies the desired \"size\" of the VM. Affects number of virtual CPUs and/or memory size given to the new cluster node VM.", 
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE"
  ], 
  "id": "ALBControllerClusterNodeVMFormFactor", 
  "module_id": "PolicyALBControllerDeployment", 
  "title": "Supported VM form factor for Advanced Load Balancer controller", 
  "type": "string"
}

ALBControllerClusterTrigger (type)

{
  "description": "Advanced Load Balancer controller node clustering trigger response.", 
  "id": "ALBControllerClusterTrigger", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "status": {
      "description": "Advanced Load Balancer controller node clustering trigger status.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node clustering trigger status", 
      "type": "string"
    }
  }, 
  "title": "Advanced Load Balancer controller node clustering trigger response", 
  "type": "object"
}

ALBControllerConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Alb Controller config details", 
  "id": "ALBControllerConfiguration", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cluster_ip": {
      "$ref": "IPAddress, 
      "description": "The cluster IP of the Advanced Load Balancer controller node cluster. This is mandatory parameter and required for single node controller deployments as well.", 
      "readonly": false, 
      "required": true, 
      "title": "Cluster IP of Advanced Load Balancer controller cluster"
    }, 
    "dns_servers": {
      "description": "List of DNS servers.", 
      "items": {
        "$ref": "IPv4Address
      }, 
      "required": false, 
      "title": "DNS servers.", 
      "type": "array"
    }, 
    "infra_admin_password": {
      "description": "Password for the controller node admin user. For deployment, this property is required. The password specified must be at least 8 characters in length.", 
      "required": true, 
      "sensitive": true, 
      "title": "Advanced Load Balancer controller admin password", 
      "type": "secure_string"
    }, 
    "infra_admin_username": {
      "description": "Username for server authentication.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "secure_string"
    }, 
    "ntp_servers": {
      "description": "List of NTP servers.", 
      "items": {
        "$ref": "HostnameOrIPv4Address
      }, 
      "required": false, 
      "title": "NTP servers.", 
      "type": "array"
    }, 
    "owned_by": {
      "description": "The policy initiates workflow by LCM/VCF", 
      "enum": [
        "LCM", 
        "VCF"
      ], 
      "required": true, 
      "title": "owned_by", 
      "type": "string"
    }
  }, 
  "title": "ALBControllerConfiguration", 
  "type": "object"
}

ALBControllerNodeFormFactor (type)

{
  "additionalProperties": false, 
  "description": "Advanced Load Balancer node form factor.", 
  "id": "ALBControllerNodeFormFactor", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "disk": {
      "description": "Disk size of the Advanced Load Balancer controller node in Bytes.", 
      "readonly": true, 
      "title": "Disk size of the Advanced Load Balancer controller node in Bytes", 
      "type": "integer"
    }, 
    "memory": {
      "description": "Memory size of the Advanced Load Balancer controller node in Bytes.", 
      "readonly": true, 
      "title": "Memory size of the Advanced Load Balancer controller node in Bytes", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "ALBControllerClusterNodeVMFormFactor, 
      "description": "Advanced Load Balancer controller node form factor type.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node form factor type"
    }, 
    "vcpu": {
      "description": "Number of virtual cpus on the Advanced Load Balancer controller node.", 
      "readonly": true, 
      "title": "Number of virtual cpus on the Advanced Load Balancer controller node", 
      "type": "integer"
    }
  }, 
  "title": "Advanced Load Balancer controller node form factor", 
  "type": "object"
}

ALBControllerNodeFormFactors (type)

{
  "id": "ALBControllerNodeFormFactors", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "form_factors": {
      "items": {
        "$ref": "ALBControllerNodeFormFactor
      }, 
      "title": "Advanced Load Balancer controller form factor list", 
      "type": "array"
    }
  }, 
  "title": "Advanced Load Balancer controller form factors list result", 
  "type": "object"
}

ALBControllerNodeInfo (type)

{
  "description": "Advanced Load Balancer controller node information like node IP and node name.", 
  "id": "ALBControllerNodeInfo", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "is_dhcp": {
      "description": "Advanced Load Balancer controller node IP configuration is static or DHCP.", 
      "readonly": true, 
      "title": "Is DHCP based IP assignment", 
      "type": "boolean"
    }, 
    "node_ip": {
      "$ref": "IPAddress, 
      "description": "Advanced Load Balancer controller node IP.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node IP"
    }, 
    "node_name": {
      "description": "Advanced Load Balancer controller node name.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node name", 
      "type": "string"
    }, 
    "node_role": {
      "description": "Advanced Load Balancer controller node role in cluster.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node role", 
      "type": "string"
    }, 
    "node_start_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Advanced Load Balancer controller node start time in its local timezone.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node start time"
    }, 
    "node_state": {
      "description": "Advanced Load Balancer controller node current state in the cluster.", 
      "readonly": true, 
      "title": "Advanced Load Balancer controller node state", 
      "type": "string"
    }, 
    "vm_id": {
      "description": "ID of the VM maintained internally. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "title": "ID of VM used to recognize it", 
      "type": "string"
    }
  }, 
  "title": "Information for Advanced Load Balancer controller nodes", 
  "type": "object"
}

ALBControllerNodeParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameters for listing the Advanced Load Balancer controller nodes.", 
  "id": "ALBControllerNodeParameters", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "state": {
      "description": "If state is pending then pending requests for Advanced Load Balancer controller VMs are shown. If state is deployed then deployed requests for Advanced Load Balancer controller VMs are shown. else show all the Advanced Load Balancer controller deployment requests.", 
      "enum": [
        "DEPLOYED", 
        "PENDING"
      ], 
      "title": "the current state of the Advanced Load Balancer controller VM", 
      "type": "string"
    }
  }, 
  "title": "List parameters for Advanced Load Balancer controller nodes", 
  "type": "object"
}

ALBControllerNodeUserSettings (type)

{
  "additionalProperties": false, 
  "id": "ALBControllerNodeUserSettings", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "admin_password": {
      "description": "Password for the controller node admin user. For deployment, this property is required. The password specified must be at least 8 characters in length.", 
      "required": true, 
      "sensitive": true, 
      "title": "Advanced Load Balancer controller admin password", 
      "type": "secure_string"
    }, 
    "admin_ssh_key": {
      "description": "To configure ssh into the Advanced Load Balancer controller, this property is required.", 
      "required": false, 
      "title": "Admin User SSH key", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ALBControllerNodeVMClusterConfig (type)

{
  "description": "Contains the cluster configuration for a Advanced Load Balancer controller node VM cluster.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ALBControllerNodeVMClusterConfig", 
  "module_id": "PolicyALBControllerDeployment", 
  "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"
    }, 
    "cluster_ip": {
      "$ref": "IPAddress, 
      "description": "The cluster IP of the Advanced Load Balancer controller node cluster. This is mandatory parameter and required for single node controller deployments as well.", 
      "readonly": false, 
      "required": true, 
      "title": "Cluster IP of Advanced Load Balancer controller cluster"
    }, 
    "cluster_name": {
      "description": "The cluster name of the Advanced Load Balancer controller node cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Cluster name of Advanced Load Balancer controller cluster", 
      "type": "string"
    }, 
    "cluster_uuid": {
      "description": "ID of the Cluster maintained internally. This is different from cluster_uuid internal to Advanced Load Balancer controller. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "title": "ID of the Advanced Load Balancer controller cluster used to recognize it", 
      "type": "string"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Info for Advanced Load Balancer controller node cluster configuration", 
  "type": "object"
}

ALBControllerNodeVMDeletionParameters (type)

{
  "description": "Parameters for deletion of a Advanced Load Balancer controller node VM.", 
  "id": "ALBControllerNodeVMDeletionParameters", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "force_delete": {
      "description": "If true, the VM will be undeployed even if it cannot be removed from its cluster.", 
      "title": "Delete by force", 
      "type": "boolean"
    }, 
    "inaccessible": {
      "description": "If inaccessible is provided along with force_delete and if this is the last node then deployment request will be deleted from NSX even if Policy objects are present.", 
      "title": "Delete when controller is inaccessible", 
      "type": "string"
    }
  }, 
  "title": "Parameters for deleting a deployed Advanced Load Balancer Controller", 
  "type": "object"
}

ALBControllerNodeVMDeploymentConfig (type)

{
  "abstract": true, 
  "description": "Contains info used to configure the VM on deployment.", 
  "id": "ALBControllerNodeVMDeploymentConfig", 
  "module_id": "PolicyALBControllerDeployment", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "placement_type"
  }, 
  "properties": {
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the VM.", 
      "enum": [
        "AlbControllerVsphereClusterNodeVmDeploymentConfig"
      ], 
      "required": true, 
      "title": "Type of deployment", 
      "type": "string"
    }
  }, 
  "title": "Configuration for deploying Advanced Load Balancer controller node VM", 
  "type": "object"
}

ALBControllerNodeVMDeploymentProgressState (type)

{
  "description": "Deployment progress state of Advanced Load Balancer controller VM. This Object contains name of current deployment step and overall progress percentage.", 
  "id": "ALBControllerNodeVMDeploymentProgressState", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "current_step_title": {
      "description": "Name of the current running step of deployment", 
      "readonly": true, 
      "required": false, 
      "title": "Name of the current step", 
      "type": "string"
    }, 
    "progress": {
      "description": "Overall progress percentage of deployment completed", 
      "readonly": true, 
      "required": false, 
      "title": "Progress percentage", 
      "type": "integer"
    }
  }, 
  "title": "Deployment progress of Advanced Load Balancer controller VM", 
  "type": "object"
}

ALBControllerNodeVMDeploymentRequest (type)

{
  "additionalProperties": false, 
  "description": "Contains the deployment information for a Advanced Load Balancer controller node VM.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ALBControllerNodeVMDeploymentRequest", 
  "module_id": "PolicyALBControllerDeployment", 
  "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"
    }, 
    "deployment_config": {
      "$ref": "ALBControllerNodeVMDeploymentConfig, 
      "description": "Deployment information and basic configuration for the Advanced Load Balancer controller.", 
      "required": true, 
      "title": "Deployment config for Advanced Load Balancer controller node VM"
    }, 
    "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"
    }, 
    "form_factor": {
      "$ref": "ALBControllerClusterNodeVMFormFactor, 
      "default": "MEDIUM", 
      "description": "Specifies the desired \"size\" of the VM", 
      "required": false, 
      "title": "Form factor for Advanced Load Balancer controller VMs."
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "user_settings": {
      "$ref": "ALBControllerNodeUserSettings, 
      "description": "SSH key and password for the Advanced Load Balancer controller node VM. Note: SSH key settings will be honored only during VM deployment.", 
      "required": true, 
      "sensitive": true, 
      "title": "User settings for the VM"
    }, 
    "vm_id": {
      "description": "ID of the VM maintained internally. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of Advanced Load Balancer controller VM used to recognize it", 
      "type": "string"
    }
  }, 
  "title": "Info for Advanced Load Balancer controller node deployment request", 
  "type": "object"
}

ALBControllerNodeVMDeploymentRequestList (type)

{
  "additionalProperties": false, 
  "description": "List of Advanced Load Balancer Controller Deployment Requests.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBControllerNodeVMDeploymentRequestList", 
  "module_id": "PolicyALBControllerDeployment", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of existing Advanced Load Balancer Controller Deployment Requests.", 
      "items": {
        "$ref": "ALBControllerNodeVMDeploymentRequest
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ALBControllerNodeVMDeploymentRequest list", 
  "type": "object"
}

ALBControllerNodeVMDeploymentStatusReport (type)

{
  "description": "Contains up-to-date information relating to an auto-deployed VM, including its status and (potentially) an error message.", 
  "id": "ALBControllerNodeVMDeploymentStatusReport", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "deployment_progress_state": {
      "$ref": "ALBControllerNodeVMDeploymentProgressState, 
      "description": "Detailed progress state of node VM deployment realization.", 
      "readonly": true, 
      "required": false, 
      "title": "Deployment progress state of node VM"
    }, 
    "failure_code": {
      "description": "In case of auto-deployment-related failure, the code for the error will be stored here.", 
      "required": false, 
      "title": "Error code for failure", 
      "type": "integer"
    }, 
    "failure_message": {
      "description": "In case of auto-deployment-related failure, an error message will be stored here.", 
      "required": false, 
      "title": "Error message for failure", 
      "type": "string"
    }, 
    "status": {
      "description": "Status of the addition or deletion of an auto-deployed Advanced Load Balancer controller node VM.", 
      "enum": [
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "VM_POWER_ON_SUCCESSFUL", 
        "VM_REGISTRATION_IN_PROGRESS", 
        "VM_REGISTRATION_SUCCESSFUL", 
        "VM_REGISTRATION_FAILED", 
        "VM_WAITING_TO_COME_ONLINE", 
        "VM_ONLINE_FAILED", 
        "VM_CONFIGURATION_IN_PROGRESS", 
        "VM_CONFIGURATION_SUCCESSFUL", 
        "VM_CONFIGURATION_FAILED", 
        "VM_CLUSTERING_QUEUED", 
        "VM_CLUSTERING_IN_PROGRESS", 
        "VM_CLUSTERING_SUCCESSFUL", 
        "VM_CLUSTERING_FAILED", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "WAITING_TO_UNDEPLOY_VM", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "UNKNOWN_STATE"
      ], 
      "required": true, 
      "title": "Auto-deployed VM's deployment status", 
      "type": "string"
    }
  }, 
  "title": "Report of a VM's deployment status", 
  "type": "object"
}

ALBControllerNodeVMUpdateParameters (type)

{
  "description": "Parameters for updating Advanced Load Balancer Controller node VM password, DNS and NTP related configuration", 
  "id": "ALBControllerNodeVMUpdateParameters", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "running_config": {
      "description": "If true, then the configuration will be updated in the running Advanced Load Balancer Controllers as well.", 
      "title": "Update Advanced Load Balancer Controller runtime config as well", 
      "type": "boolean"
    }
  }, 
  "title": "Parameters for updating Advanced Load Balancer Controller request", 
  "type": "object"
}

ALBControllerVersion (type)

{
  "description": "ALB Controller Version", 
  "id": "ALBControllerVersion", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "alb_api_version": {
      "description": "It is ALB API version supported by NSX-ALB.", 
      "title": "Alb API Version", 
      "type": "string"
    }, 
    "alb_controller_version": {
      "description": "It is ALB Controller version deployed by NSX-ALB.", 
      "title": "Alb Controller Version", 
      "type": "string"
    }
  }, 
  "title": "ALBControllerVersion", 
  "type": "object"
}

ALBCookieMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CookieMatch object", 
  "id": "ALBCookieMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBHdrMatchOperation, 
      "description": "Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "name": {
      "description": "Name of the cookie.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "value": {
      "description": "String value in the cookie.", 
      "required": false, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "CookieMatch", 
  "type": "object"
}

ALBCustomParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer CustomParams object", 
  "id": "ALBCustomParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "is_dynamic": {
      "default": false, 
      "description": "Placeholder for description of property is_dynamic of obj type CustomParams field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is dynamic", 
      "type": "boolean"
    }, 
    "is_sensitive": {
      "default": false, 
      "description": "Placeholder for description of property is_sensitive of obj type CustomParams field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is sensitive", 
      "type": "boolean"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "value": {
      "description": "value of CustomParams.", 
      "required": false, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "CustomParams", 
  "type": "object"
}

ALBDiscoveredNetwork (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DiscoveredNetwork object", 
  "id": "ALBDiscoveredNetwork", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "network_name": {
      "description": "Discovered network for this IP. It is a reference to an object of type Network.", 
      "required": true, 
      "title": "Network name", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "NESTED_SERVICE_RELATIONSHIP", 
          "rightType": [
            "Service"
          ]
        }
      ]
    }, 
    "subnet": {
      "description": "Discovered subnet for this IP.", 
      "items": {
        "$ref": "ALBIpAddrPrefix
      }, 
      "required": false, 
      "title": "Subnet", 
      "type": "array"
    }, 
    "subnet6": {
      "description": "Discovered IPv6 subnet for this IP.", 
      "items": {
        "$ref": "ALBIpAddrPrefix
      }, 
      "required": false, 
      "title": "Subnet6", 
      "type": "array"
    }
  }, 
  "title": "DiscoveredNetwork", 
  "type": "object"
}

ALBDnsAAAARdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsAAAARdata object", 
  "id": "ALBDnsAAAARdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip6_address": {
      "$ref": "ALBIpAddr, 
      "description": "IPv6 address for FQDN.", 
      "required": true, 
      "title": "Ip6 address"
    }
  }, 
  "title": "DnsAAAARdata", 
  "type": "object"
}

ALBDnsARdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsARdata object", 
  "id": "ALBDnsARdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip_address": {
      "$ref": "ALBIpAddr, 
      "description": "IP address for FQDN.", 
      "required": true, 
      "title": "Ip address"
    }
  }, 
  "title": "DnsARdata", 
  "type": "object"
}

ALBDnsAttack (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsAttack object", 
  "id": "ALBDnsAttack", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "attack_vector": {
      "$ref": "ALBDnsAttackVector, 
      "description": "The DNS attack vector. Enum options - DNS_REFLECTION, DNS_NXDOMAIN, DNS_AMPLIFICATION_EGRESS.", 
      "required": true, 
      "title": "Attack vector"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable or disable the mitigation of the attack vector. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "max_mitigation_age": {
      "default": 60, 
      "description": "Time in minutes after which mitigation will be deactivated. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 60.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Max mitigation age", 
      "type": "integer"
    }, 
    "mitigation_action": {
      "$ref": "ALBAttackMitigationAction, 
      "description": "Mitigation action to perform for this DNS attack vector.", 
      "required": false, 
      "title": "Mitigation action"
    }, 
    "threshold": {
      "description": "Threshold, in terms of DNS packet per second, for the DNS attack vector.", 
      "required": false, 
      "title": "Threshold", 
      "type": "integer"
    }
  }, 
  "title": "DnsAttack", 
  "type": "object"
}

ALBDnsAttackVector (type)

{
  "description": "Valid ENUM values for ALBDnsAttackVector", 
  "enum": [
    "DNS_REFLECTION", 
    "DNS_NXDOMAIN", 
    "DNS_AMPLIFICATION_EGRESS"
  ], 
  "id": "ALBDnsAttackVector", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsAttackVector type", 
  "type": "string"
}

ALBDnsAttacks (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsAttacks object", 
  "id": "ALBDnsAttacks", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "attacks": {
      "description": "Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks.", 
      "items": {
        "$ref": "ALBDnsAttack
      }, 
      "required": false, 
      "title": "Attacks", 
      "type": "array"
    }, 
    "oper_mode": {
      "$ref": "ALBOperationMode, 
      "description": "Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Enum options - DETECTION, MITIGATION.", 
      "required": false, 
      "title": "Oper mode"
    }
  }, 
  "title": "DnsAttacks", 
  "type": "object"
}

ALBDnsClientIpMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsClientIpMatch object", 
  "id": "ALBDnsClientIpMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "IP addresses to match against client IP.", 
      "required": true, 
      "title": "Client ip"
    }, 
    "use_edns_client_subnet_ip": {
      "default": true, 
      "description": "Use the IP address from the EDNS client subnet option, if available, as the source IP address of the client. It should be noted that the edns subnet IP may not be a /32 IP address. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Use edns client subnet ip", 
      "type": "boolean"
    }
  }, 
  "title": "DnsClientIpMatch", 
  "type": "object"
}

ALBDnsCnameRdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsCnameRdata object", 
  "id": "ALBDnsCnameRdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cname": {
      "description": "Canonical name.", 
      "required": true, 
      "title": "Cname", 
      "type": "string"
    }
  }, 
  "title": "DnsCnameRdata", 
  "type": "object"
}

ALBDnsErrorResponseType (type)

{
  "description": "Valid ENUM values for ALBDnsErrorResponseType", 
  "enum": [
    "DNS_ERROR_RESPONSE_ERROR", 
    "DNS_ERROR_RESPONSE_NONE"
  ], 
  "id": "ALBDnsErrorResponseType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsErrorResponseType type", 
  "type": "string"
}

ALBDnsGeoLocationMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsGeoLocationMatch object", 
  "id": "ALBDnsGeoLocationMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "geolocation_name": {
      "description": "Geographical location of the client IP to be used in the match. This location is of the format Country/State/City e.g. US/CA/Santa Clara.", 
      "required": false, 
      "title": "Geolocation name", 
      "type": "string"
    }, 
    "geolocation_tag": {
      "description": "Geolocation tag for the client IP. This could be any string value for the client IP, e.g. client IPs from US East Coast geolocation would be tagged as 'East Coast'.", 
      "required": false, 
      "title": "Geolocation tag", 
      "type": "string"
    }, 
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for matching the client IP's geographical location. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "use_edns_client_subnet_ip": {
      "default": true, 
      "description": "Use the IP address from the EDNS client subnet option, if available, to derive geo location of the DNS query. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Use edns client subnet ip", 
      "type": "boolean"
    }
  }, 
  "title": "DnsGeoLocationMatch", 
  "type": "object"
}

ALBDnsInfo (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsInfo object", 
  "id": "ALBDnsInfo", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "algorithm": {
      "$ref": "ALBDnsRecordResponseAlgorithm, 
      "default": "DNS_RECORD_RESPONSE_CONSISTENT_HASH", 
      "description": "Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RECORD_RESPONSE_CONSISTENT_HASH.", 
      "required": false, 
      "title": "Algorithm"
    }, 
    "cname": {
      "$ref": "ALBDnsCnameRdata, 
      "description": "Canonical name in CNAME record.", 
      "required": false, 
      "title": "Cname"
    }, 
    "fqdn": {
      "description": "Fully qualified domain name.", 
      "required": false, 
      "title": "Fqdn", 
      "type": "string"
    }, 
    "metadata": {
      "description": "Any metadata associated with this record.", 
      "required": false, 
      "title": "Metadata", 
      "type": "string"
    }, 
    "num_records_in_response": {
      "description": "Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'.", 
      "maximum": 20, 
      "minimum": 0, 
      "required": false, 
      "title": "Num records in response", 
      "type": "integer"
    }, 
    "ttl": {
      "description": "Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided.", 
      "required": false, 
      "title": "Ttl", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "ALBDnsRecordType, 
      "default": "DNS_RECORD_A", 
      "description": "DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RECORD_A.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "DnsInfo", 
  "type": "object"
}

ALBDnsMessageSection (type)

{
  "description": "Valid ENUM values for ALBDnsMessageSection", 
  "enum": [
    "DNS_MESSAGE_SECTION_QUESTION", 
    "DNS_MESSAGE_SECTION_ANSWER", 
    "DNS_MESSAGE_SECTION_AUTHORITY", 
    "DNS_MESSAGE_SECTION_ADDITIONAL"
  ], 
  "id": "ALBDnsMessageSection", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsMessageSection type", 
  "type": "string"
}

ALBDnsMxRdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsMxRdata object", 
  "id": "ALBDnsMxRdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host": {
      "description": "Fully qualified domain name of a mailserver. The host name maps directly to one or more address records in the DNS table, and must not point to any CNAME records (RFC 2181).", 
      "required": true, 
      "title": "Host", 
      "type": "string"
    }, 
    "priority": {
      "description": "The priority field identifies which mail server should be preferred. Allowed values are 0-65535.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Priority", 
      "type": "integer"
    }
  }, 
  "title": "DnsMxRdata", 
  "type": "object"
}

ALBDnsNsRdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsNsRdata object", 
  "id": "ALBDnsNsRdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip6_address": {
      "$ref": "ALBIpAddr, 
      "description": "IPv6 address for Name Server.", 
      "required": false, 
      "title": "Ip6 address"
    }, 
    "ip_address": {
      "$ref": "ALBIpAddr, 
      "description": "IP address for Name Server.", 
      "required": false, 
      "title": "Ip address"
    }, 
    "nsname": {
      "description": "Name Server name.", 
      "required": true, 
      "title": "Nsname", 
      "type": "string"
    }
  }, 
  "title": "DnsNsRdata", 
  "type": "object"
}

ALBDnsPolicies (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsPolicies object", 
  "id": "ALBDnsPolicies", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dns_policy_path": {
      "description": "path of the dns policy. It is a reference to an object of type DnsPolicy.", 
      "required": true, 
      "title": "Dns policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_DNSPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBDnsPolicy"
          ]
        }
      ]
    }, 
    "index": {
      "description": "Index of the dns policy.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }
  }, 
  "title": "DnsPolicies", 
  "type": "object"
}

ALBDnsPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBDnsPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule": {
      "description": "DNS rules.", 
      "items": {
        "$ref": "ALBDnsRule
      }, 
      "required": false, 
      "title": "Rule", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DnsPolicy", 
  "type": "object"
}

ALBDnsPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "DnsPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBDnsPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of DnsPolicy", 
      "items": {
        "$ref": "ALBDnsPolicy
      }, 
      "required": false, 
      "title": "Array of DnsPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DnsPolicyApiResponse", 
  "type": "object"
}

ALBDnsQueryNameMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsQueryNameMatch object", 
  "id": "ALBDnsQueryNameMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBStringOperation, 
      "description": "Criterion to use for string matching the DNS query domain name in the question section. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "query_domain_names": {
      "description": "Domain name to match against that specified in the question section of the DNS query.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Query domain names", 
      "type": "array"
    }, 
    "string_group_paths": {
      "description": "path of the string group(s) for matching against DNS query domain name in the question section. It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "String group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBDnsPolicy"
          ], 
          "relationshipType": "ALB_DNSPOLICY_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }
  }, 
  "title": "DnsQueryNameMatch", 
  "type": "object"
}

ALBDnsQueryTypeMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsQueryTypeMatch object", 
  "id": "ALBDnsQueryTypeMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for matching the DNS query typein the question section. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "query_type": {
      "description": "DNS query types in the request query. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.", 
      "items": {
        "$ref": "ALBDnsRecordType
      }, 
      "required": false, 
      "title": "Query type", 
      "type": "array"
    }
  }, 
  "title": "DnsQueryTypeMatch", 
  "type": "object"
}

ALBDnsRateLimiter (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRateLimiter object", 
  "id": "ALBDnsRateLimiter", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBDnsRuleRLAction, 
      "description": "Action to perform upon rate limiting.", 
      "required": true, 
      "title": "Action"
    }, 
    "rate_limiter_object": {
      "$ref": "ALBRateLimiter, 
      "description": "Rate limiting object.", 
      "required": true, 
      "title": "Rate limiter object"
    }
  }, 
  "title": "DnsRateLimiter", 
  "type": "object"
}

ALBDnsRcode (type)

{
  "description": "Valid ENUM values for ALBDnsRcode", 
  "enum": [
    "DNS_RCODE_NOERROR", 
    "DNS_RCODE_FORMERR", 
    "DNS_RCODE_SERVFAIL", 
    "DNS_RCODE_NXDOMAIN", 
    "DNS_RCODE_NOTIMP", 
    "DNS_RCODE_REFUSED", 
    "DNS_RCODE_YXDOMAIN", 
    "DNS_RCODE_YXRRSET", 
    "DNS_RCODE_NXRRSET", 
    "DNS_RCODE_NOTAUTH", 
    "DNS_RCODE_NOTZONE"
  ], 
  "id": "ALBDnsRcode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsRcode type", 
  "type": "string"
}

ALBDnsRecord (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRecord object", 
  "id": "ALBDnsRecord", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "algorithm": {
      "$ref": "ALBDnsRecordResponseAlgorithm, 
      "default": "DNS_RECORD_RESPONSE_ROUND_ROBIN", 
      "description": "Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RECORD_RESPONSE_ROUND_ROBIN.", 
      "required": false, 
      "title": "Algorithm"
    }, 
    "cname": {
      "$ref": "ALBDnsCnameRdata, 
      "description": "Canonical name in CNAME record.", 
      "required": false, 
      "title": "Cname"
    }, 
    "delegated": {
      "default": false, 
      "description": "Configured FQDNs are delegated domains (i.e. they represent a zone cut). Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Delegated", 
      "type": "boolean"
    }, 
    "description": {
      "description": "Details of DNS record.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "fqdn": {
      "description": "Fully Qualified Domain Name. Minimum of 1 items required.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Fqdn", 
      "type": "array"
    }, 
    "ip6_address": {
      "description": "IPv6 address in AAAA record. Maximum of 4 items allowed.", 
      "items": {
        "$ref": "ALBDnsAAAARdata
      }, 
      "required": false, 
      "title": "Ip6 address", 
      "type": "array"
    }, 
    "ip_address": {
      "description": "IP address in A record. Maximum of 4 items allowed.", 
      "items": {
        "$ref": "ALBDnsARdata
      }, 
      "required": false, 
      "title": "Ip address", 
      "type": "array"
    }, 
    "metadata": {
      "description": "Internal metadata for the DNS record.", 
      "required": false, 
      "title": "Metadata", 
      "type": "string"
    }, 
    "mx_records": {
      "description": "MX record. Maximum of 4 items allowed.", 
      "items": {
        "$ref": "ALBDnsMxRdata
      }, 
      "required": false, 
      "title": "Mx records", 
      "type": "array"
    }, 
    "ns": {
      "description": "Name Server information in NS record. Maximum of 13 items allowed.", 
      "items": {
        "$ref": "ALBDnsNsRdata
      }, 
      "required": false, 
      "title": "Ns", 
      "type": "array"
    }, 
    "num_records_in_response": {
      "default": 0, 
      "description": "Specifies the number of records returned by the DNS service. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 20, 
      "minimum": 0, 
      "required": false, 
      "title": "Num records in response", 
      "type": "integer"
    }, 
    "service_locator": {
      "description": "Service locator info in SRV record. Maximum of 4 items allowed.", 
      "items": {
        "$ref": "ALBDnsSrvRdata
      }, 
      "required": false, 
      "title": "Service locator", 
      "type": "array"
    }, 
    "ttl": {
      "description": "Time To Live for this DNS record.", 
      "required": false, 
      "title": "Ttl", 
      "type": "integer"
    }, 
    "txt_records": {
      "description": "Text record. Maximum of 4 items allowed.", 
      "items": {
        "$ref": "ALBDnsTxtRdata
      }, 
      "required": false, 
      "title": "Txt records", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBDnsRecordType, 
      "description": "DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.", 
      "required": true, 
      "title": "Type"
    }, 
    "wildcard_match": {
      "default": false, 
      "description": "Enable wild-card match of fqdn  if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Wildcard match", 
      "type": "boolean"
    }
  }, 
  "title": "DnsRecord", 
  "type": "object"
}

ALBDnsRecordResponseAlgorithm (type)

{
  "description": "Valid ENUM values for ALBDnsRecordResponseAlgorithm", 
  "enum": [
    "DNS_RECORD_RESPONSE_ROUND_ROBIN", 
    "DNS_RECORD_RESPONSE_CONSISTENT_HASH"
  ], 
  "id": "ALBDnsRecordResponseAlgorithm", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsRecordResponseAlgorithm type", 
  "type": "string"
}

ALBDnsRecordType (type)

{
  "description": "Valid ENUM values for ALBDnsRecordType", 
  "enum": [
    "DNS_RECORD_OTHER", 
    "DNS_RECORD_A", 
    "DNS_RECORD_NS", 
    "DNS_RECORD_CNAME", 
    "DNS_RECORD_SOA", 
    "DNS_RECORD_PTR", 
    "DNS_RECORD_HINFO", 
    "DNS_RECORD_MX", 
    "DNS_RECORD_TXT", 
    "DNS_RECORD_RP", 
    "DNS_RECORD_DNSKEY", 
    "DNS_RECORD_AAAA", 
    "DNS_RECORD_SRV", 
    "DNS_RECORD_OPT", 
    "DNS_RECORD_RRSIG", 
    "DNS_RECORD_AXFR", 
    "DNS_RECORD_ANY"
  ], 
  "id": "ALBDnsRecordType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsRecordType type", 
  "type": "string"
}

ALBDnsRrSet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRrSet object", 
  "id": "ALBDnsRrSet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cname": {
      "$ref": "ALBDnsCnameRdata, 
      "description": "Canonical name in CNAME record.", 
      "required": false, 
      "title": "Cname"
    }, 
    "fqdn": {
      "description": "Fully Qualified Domain Name.", 
      "required": true, 
      "title": "Fqdn", 
      "type": "string"
    }, 
    "ip6_addresses": {
      "description": "IPv6 address in AAAA record.", 
      "items": {
        "$ref": "ALBDnsAAAARdata
      }, 
      "required": false, 
      "title": "Ip6 addresses", 
      "type": "array"
    }, 
    "ip_addresses": {
      "description": "IP address in A record.", 
      "items": {
        "$ref": "ALBDnsARdata
      }, 
      "required": false, 
      "title": "Ip addresses", 
      "type": "array"
    }, 
    "nses": {
      "description": "Name Server information in NS record.", 
      "items": {
        "$ref": "ALBDnsNsRdata
      }, 
      "required": false, 
      "title": "Nses", 
      "type": "array"
    }, 
    "ttl": {
      "description": "Time To Live for this DNS record. Allowed values are 0-2147483647.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": true, 
      "title": "Ttl", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "ALBDnsRecordType, 
      "description": "DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "DnsRrSet", 
  "type": "object"
}

ALBDnsRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRule object", 
  "id": "ALBDnsRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBDnsRuleAction, 
      "description": "Action to be performed upon successful matching.", 
      "required": false, 
      "title": "Action"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "log": {
      "description": "Log DNS query upon rule match.", 
      "required": false, 
      "title": "Log", 
      "type": "boolean"
    }, 
    "match": {
      "$ref": "ALBDnsRuleMatchTarget, 
      "description": "Add match criteria to the rule.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "DnsRule", 
  "type": "object"
}

ALBDnsRuleAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleAction object", 
  "id": "ALBDnsRuleAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "allow": {
      "$ref": "ALBDnsRuleActionAllowDrop, 
      "description": "Allow or drop the DNS query.", 
      "required": false, 
      "title": "Allow"
    }, 
    "dns_rate_limiter": {
      "$ref": "ALBDnsRateLimiter, 
      "description": "Rate limits the DNS requests.", 
      "required": false, 
      "title": "Dns rate limiter"
    }, 
    "gslb_site_selection": {
      "$ref": "ALBDnsRuleActionGslbSiteSelection, 
      "description": "Select a specific GSLB site for the DNS query. This action should be used only when GSLB services have been configured for the DNS virtual service.", 
      "required": false, 
      "title": "Gslb site selection"
    }, 
    "pool_switching": {
      "$ref": "ALBDnsRuleActionPoolSwitching, 
      "description": "Select a pool or pool group for the passthrough DNS query which cannot be served locally but could be served by upstream servers.", 
      "required": false, 
      "title": "Pool switching"
    }, 
    "response": {
      "$ref": "ALBDnsRuleActionResponse, 
      "description": "Generate a response for the DNS query.", 
      "required": false, 
      "title": "Response"
    }
  }, 
  "title": "DnsRuleAction", 
  "type": "object"
}

ALBDnsRuleActionAllowDrop (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleActionAllowDrop object", 
  "id": "ALBDnsRuleActionAllowDrop", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "allow": {
      "default": true, 
      "description": "Allow the DNS query. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Allow", 
      "type": "boolean"
    }, 
    "reset_conn": {
      "default": true, 
      "description": "Reset the TCP connection of the DNS query, if allow is set to false to drop the query. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Reset conn", 
      "type": "boolean"
    }
  }, 
  "title": "DnsRuleActionAllowDrop", 
  "type": "object"
}

ALBDnsRuleActionGslbSiteSelection (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleActionGslbSiteSelection object", 
  "id": "ALBDnsRuleActionGslbSiteSelection", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "fallback_site_names": {
      "description": "GSLB fallback sites to use in case the desired site is down. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Fallback site names", 
      "type": "array"
    }, 
    "is_site_preferred": {
      "default": true, 
      "description": "When set to true, GSLB site is a preferred site. This setting comes into play when the site is down, as well as no configured fallback site is available (all fallback sites are also down), then any one available site is selected based on the default algorithm for GSLB pool member selection. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Is site preferred", 
      "type": "boolean"
    }, 
    "site_name": {
      "description": "GSLB site name.", 
      "required": true, 
      "title": "Site name", 
      "type": "string"
    }
  }, 
  "title": "DnsRuleActionGslbSiteSelection", 
  "type": "object"
}

ALBDnsRuleActionPoolSwitching (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleActionPoolSwitching object", 
  "id": "ALBDnsRuleActionPoolSwitching", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "pool_group_path": {
      "description": "Reference of the pool group to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type PoolGroup.", 
      "required": false, 
      "title": "Pool group path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBDnsPolicy"
          ], 
          "relationshipType": "ALB_DNSPOLICY_ALB_POOLGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroup"
          ]
        }
      ]
    }, 
    "pool_path": {
      "description": "Reference of the pool to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type Pool.", 
      "required": false, 
      "title": "Pool path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBDnsPolicy"
          ], 
          "relationshipType": "ALB_DNSPOLICY_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }
  }, 
  "title": "DnsRuleActionPoolSwitching", 
  "type": "object"
}

ALBDnsRuleActionResponse (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleActionResponse object", 
  "id": "ALBDnsRuleActionResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "authoritative": {
      "default": true, 
      "description": "DNS response is authoritative. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Authoritative", 
      "type": "boolean"
    }, 
    "rcode": {
      "$ref": "ALBDnsRcode, 
      "default": "DNS_RCODE_NOERROR", 
      "description": "DNS response code. Enum options - DNS_RCODE_NOERROR, DNS_RCODE_FORMERR, DNS_RCODE_SERVFAIL, DNS_RCODE_NXDOMAIN, DNS_RCODE_NOTIMP, DNS_RCODE_REFUSED, DNS_RCODE_YXDOMAIN, DNS_RCODE_YXRRSET, DNS_RCODE_NXRRSET, DNS_RCODE_NOTAUTH, DNS_RCODE_NOTZONE. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RCODE_NOERROR.", 
      "required": false, 
      "title": "Rcode"
    }, 
    "resource_record_sets": {
      "description": "DNS resource record sets - (resource record set share the DNS domain name, type, and class).", 
      "items": {
        "$ref": "ALBDnsRuleDnsRrSet
      }, 
      "required": false, 
      "title": "Resource record sets", 
      "type": "array"
    }, 
    "truncation": {
      "default": false, 
      "description": "DNS response is truncated. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Truncation", 
      "type": "boolean"
    }
  }, 
  "title": "DnsRuleActionResponse", 
  "type": "object"
}

ALBDnsRuleDnsRrSet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleDnsRrSet object", 
  "id": "ALBDnsRuleDnsRrSet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "resource_record_set": {
      "$ref": "ALBDnsRrSet, 
      "description": "DNS resource record set - (records in the resource record set share the DNS domain name, type, and class).", 
      "required": true, 
      "title": "Resource record set"
    }, 
    "section": {
      "$ref": "ALBDnsMessageSection, 
      "default": "DNS_MESSAGE_SECTION_ANSWER", 
      "description": "DNS message section for the resource record set. Enum options - DNS_MESSAGE_SECTION_QUESTION, DNS_MESSAGE_SECTION_ANSWER, DNS_MESSAGE_SECTION_AUTHORITY, DNS_MESSAGE_SECTION_ADDITIONAL. Default value when not specified in API or module is interpreted by ALB Controller as DNS_MESSAGE_SECTION_ANSWER.", 
      "required": false, 
      "title": "Section"
    }
  }, 
  "title": "DnsRuleDnsRrSet", 
  "type": "object"
}

ALBDnsRuleMatchTarget (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleMatchTarget object", 
  "id": "ALBDnsRuleMatchTarget", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip_address": {
      "$ref": "ALBDnsClientIpMatch, 
      "description": "IP addresses to match against client IP or the EDNS client subnet IP.", 
      "required": false, 
      "title": "Client ip address"
    }, 
    "geo_location": {
      "$ref": "ALBDnsGeoLocationMatch, 
      "description": "Geographical location attribute to match against that of the client IP.", 
      "required": false, 
      "title": "Geo location"
    }, 
    "protocol": {
      "$ref": "ALBDnsTransportProtocolMatch, 
      "description": "DNS transport protocol match.", 
      "required": false, 
      "title": "Protocol"
    }, 
    "query_name": {
      "$ref": "ALBDnsQueryNameMatch, 
      "description": "Domain names to match against query name.", 
      "required": false, 
      "title": "Query name"
    }, 
    "query_type": {
      "$ref": "ALBDnsQueryTypeMatch, 
      "description": "DNS query types to match against request query type.", 
      "required": false, 
      "title": "Query type"
    }
  }, 
  "title": "DnsRuleMatchTarget", 
  "type": "object"
}

ALBDnsRuleRLAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsRuleRLAction object", 
  "id": "ALBDnsRuleRLAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "type": {
      "$ref": "ALBDnsRuleRLActionType, 
      "default": "DNS_RL_ACTION_NONE", 
      "description": "Type of action to be enforced upon hitting the rate limit. Enum options - DNS_RL_ACTION_NONE, DNS_RL_ACTION_DROP_REQ. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RL_ACTION_NONE.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "DnsRuleRLAction", 
  "type": "object"
}

ALBDnsRuleRLActionType (type)

{
  "description": "Valid ENUM values for ALBDnsRuleRLActionType", 
  "enum": [
    "DNS_RL_ACTION_NONE", 
    "DNS_RL_ACTION_DROP_REQ"
  ], 
  "id": "ALBDnsRuleRLActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsRuleRLActionType type", 
  "type": "string"
}

ALBDnsServiceApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsServiceApplicationProfile object", 
  "id": "ALBDnsServiceApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "aaaa_empty_response": {
      "default": true, 
      "description": "Respond to AAAA queries with empty response when there are only IPV4 records. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Aaaa empty response", 
      "type": "boolean"
    }, 
    "admin_email": {
      "default": "hostmaster", 
      "description": "Email address of the administrator responsible for this zone. This field is used in SOA records (rname) pertaining to all domain names specified as authoritative domain names. If not configured, the default value 'hostmaster' is used in SOA responses. Default value when not specified in API or module is interpreted by ALB Controller as hostmaster.", 
      "required": false, 
      "title": "Admin email", 
      "type": "string"
    }, 
    "dns_over_tcp_enabled": {
      "default": true, 
      "description": "Enable DNS query/response over TCP. This enables analytics for pass-through queries as well. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Dns over tcp enabled", 
      "type": "boolean"
    }, 
    "dns_zones": {
      "description": "DNS zones hosted on this Virtual Service. Maximum of 100 items allowed.", 
      "items": {
        "$ref": "ALBDnsZone
      }, 
      "required": false, 
      "title": "Dns zones", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "Subdomain names serviced by this Virtual Service. These are configured as Ends-With semantics. Maximum of 100 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain names", 
      "type": "array"
    }, 
    "ecs_stripping_enabled": {
      "default": true, 
      "description": "Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Ecs stripping enabled", 
      "type": "boolean"
    }, 
    "edns": {
      "default": true, 
      "description": "Enable DNS service to be aware of EDNS (Extension mechanism for DNS). EDNS extensions are parsed and shown in logs. For GSLB services, the EDNS client subnet option can be used to influence Load Balancing. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Edns", 
      "type": "boolean"
    }, 
    "edns_client_subnet_prefix_len": {
      "description": "Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option. When the incoming request does not have any ECS option and the prefix length is specified, an ECS option is inserted in the request passed to upstream server. If the incoming request already has an ECS option, the prefix length (and correspondingly the address) in the ECS option is updated, with the minimum of the prefix length present in the incoming and the configured prefix length, before passing the request to upstream server. Allowed values are 1-32.", 
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "Edns client subnet prefix len", 
      "type": "integer"
    }, 
    "error_response": {
      "$ref": "ALBDnsErrorResponseType, 
      "default": "DNS_ERROR_RESPONSE_NONE", 
      "description": "Drop or respond to client when the DNS service encounters an error processing a client query. By default, such a request is dropped without any response, or passed through to a passthrough pool, if configured. When set to respond, an appropriate response is sent to client, e.g. NXDOMAIN response for non-existent records, empty NOERROR response for unsupported queries, etc. Enum options - DNS_ERROR_RESPONSE_ERROR, DNS_ERROR_RESPONSE_NONE. Default value when not specified in API or module is interpreted by ALB Controller as DNS_ERROR_RESPONSE_NONE.", 
      "required": false, 
      "title": "Error response"
    }, 
    "name_server": {
      "description": "The <domain-name>  of the name server that was the original or primary source of data for this zone. This field is used in SOA records (mname) pertaining to all domain names specified as authoritative domain names. If not configured, domain name is used as name server in SOA response.", 
      "required": false, 
      "title": "Name server", 
      "type": "string"
    }, 
    "negative_caching_ttl": {
      "default": 30, 
      "description": "Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "maximum": 86400, 
      "minimum": 0, 
      "required": false, 
      "title": "Negative caching ttl", 
      "type": "integer"
    }, 
    "num_dns_ip": {
      "default": 1, 
      "description": "Specifies the number of IP addresses returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- 'Return all IP addresses'. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 20, 
      "minimum": 0, 
      "required": false, 
      "title": "Num dns ip", 
      "type": "integer"
    }, 
    "ttl": {
      "default": 30, 
      "description": "Specifies the TTL value (in seconds) for records served by DNS Service. Allowed values are 0-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "maximum": 86400, 
      "minimum": 0, 
      "required": false, 
      "title": "Ttl", 
      "type": "integer"
    }
  }, 
  "title": "DnsServiceApplicationProfile", 
  "type": "object"
}

ALBDnsSrvRdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsSrvRdata object", 
  "id": "ALBDnsSrvRdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "port": {
      "description": "Service port. Allowed values are 0-65535.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Port", 
      "type": "integer"
    }, 
    "priority": {
      "default": 0, 
      "description": "Priority of the target hosting the service, low value implies higher priority for this service record. Allowed values are 0-65535. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Priority", 
      "type": "integer"
    }, 
    "target": {
      "default": "default.host", 
      "description": "Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'. Default value when not specified in API or module is interpreted by ALB Controller as default.host.", 
      "required": false, 
      "title": "Target", 
      "type": "string"
    }, 
    "weight": {
      "default": 0, 
      "description": "Relative weight for service records with same priority, high value implies higher preference for this service record. Allowed values are 0-65535. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Weight", 
      "type": "integer"
    }
  }, 
  "title": "DnsSrvRdata", 
  "type": "object"
}

ALBDnsTransportProtocol (type)

{
  "description": "Valid ENUM values for ALBDnsTransportProtocol", 
  "enum": [
    "DNS_OVER_UDP", 
    "DNS_OVER_TCP"
  ], 
  "id": "ALBDnsTransportProtocol", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DnsTransportProtocol type", 
  "type": "string"
}

ALBDnsTransportProtocolMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsTransportProtocolMatch object", 
  "id": "ALBDnsTransportProtocolMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for matching the DNS transport protocol. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "protocol": {
      "$ref": "ALBDnsTransportProtocol, 
      "description": "Protocol to match against transport protocol used by DNS query. Enum options - DNS_OVER_UDP, DNS_OVER_TCP.", 
      "required": true, 
      "title": "Protocol"
    }
  }, 
  "title": "DnsTransportProtocolMatch", 
  "type": "object"
}

ALBDnsTxtRdata (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsTxtRdata object", 
  "id": "ALBDnsTxtRdata", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "text_str": {
      "description": "Text data associated with the FQDN.", 
      "required": true, 
      "title": "Text str", 
      "type": "string"
    }
  }, 
  "title": "DnsTxtRdata", 
  "type": "object"
}

ALBDnsZone (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DnsZone object", 
  "id": "ALBDnsZone", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "admin_email": {
      "description": "Email address of the administrator responsible for this zone. This field is used in SOA records as rname (RFC 1035). If not configured, it is inherited from the DNS service profile.", 
      "required": false, 
      "title": "Admin email", 
      "type": "string"
    }, 
    "domain_name": {
      "description": "Domain name authoritatively serviced by this Virtual Service. Queries for FQDNs that are sub domains of this domain and do not have any DNS record in Avi are dropped or NXDomain response sent. For domains which are present, SOA parameters are sent in answer section of response if query type is SOA.", 
      "required": true, 
      "title": "Domain name", 
      "type": "string"
    }, 
    "name_server": {
      "description": "The primary name server for this zone. This field is used in SOA records as mname (RFC 1035). If not configured, it is inherited from the DNS service profile. If even that is not configured, the domain name is used instead.", 
      "required": false, 
      "title": "Name server", 
      "type": "string"
    }
  }, 
  "title": "DnsZone", 
  "type": "object"
}

ALBDosRateLimitProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DosRateLimitProfile object", 
  "id": "ALBDosRateLimitProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dos_profile": {
      "$ref": "ALBDosThresholdProfile, 
      "description": "Profile for DoS attack detection.", 
      "required": false, 
      "title": "Dos profile"
    }, 
    "rl_profile": {
      "$ref": "ALBRateLimiterProfile, 
      "description": "Profile for Connections/Requests rate limiting.", 
      "required": false, 
      "title": "Rl profile"
    }
  }, 
  "title": "DosRateLimitProfile", 
  "type": "object"
}

ALBDosThreshold (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DosThreshold object", 
  "id": "ALBDosThreshold", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "attack": {
      "$ref": "ALBAttackType, 
      "description": "Attack type. Enum options - LAND, SMURF, ICMP_PING_FLOOD, UNKOWN_PROTOCOL, TEARDROP, IP_FRAG_OVERRUN, IP_FRAG_TOOSMALL, IP_FRAG_FULL, IP_FRAG_INCOMPLETE, PORT_SCAN, TCP_NON_SYN_FLOOD_OLD, SYN_FLOOD, BAD_RST_FLOOD, MALFORMED_FLOOD, FAKE_SESSION, ZERO_WINDOW_STRESS, SMALL_WINDOW_STRESS, DOS_HTTP_TIMEOUT, DOS_HTTP_ERROR, DOS_HTTP_ABORT...", 
      "required": true, 
      "title": "Attack"
    }, 
    "max_value": {
      "description": "Maximum number of packets or connections or requests in a given interval of time to be deemed as attack.", 
      "required": true, 
      "title": "Max value", 
      "type": "integer"
    }, 
    "min_value": {
      "description": "Minimum number of packets or connections or requests in a given interval of time to be deemed as attack.", 
      "required": true, 
      "title": "Min value", 
      "type": "integer"
    }
  }, 
  "title": "DosThreshold", 
  "type": "object"
}

ALBDosThresholdProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DosThresholdProfile object", 
  "id": "ALBDosThresholdProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "thresh_info": {
      "description": "Attack type, min and max values for DoS attack detection.", 
      "items": {
        "$ref": "ALBDosThreshold
      }, 
      "required": false, 
      "title": "Thresh info", 
      "type": "array"
    }, 
    "thresh_period": {
      "default": 5, 
      "description": "Timer value in seconds to collect DoS attack metrics based on threshold on the Service Engine for this Virtual Service. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 5.", 
      "required": true, 
      "title": "Thresh period", 
      "type": "integer"
    }
  }, 
  "title": "DosThresholdProfile", 
  "type": "object"
}

ALBDsrProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer DsrProfile object", 
  "id": "ALBDsrProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dsr_encap_type": {
      "$ref": "ALBEncapType, 
      "default": "ENCAP_IPINIP", 
      "description": "Encapsulation type to use when DSR is L3. Enum options - ENCAP_IPINIP. Default value when not specified in API or module is interpreted by ALB Controller as ENCAP_IPINIP.", 
      "required": false, 
      "title": "Dsr encap type"
    }, 
    "dsr_type": {
      "$ref": "ALBDsrType, 
      "default": "DSR_TYPE_L3", 
      "description": "DSR type L2/L3. Enum options - DSR_TYPE_L2, DSR_TYPE_L3. Default value when not specified in API or module is interpreted by ALB Controller as DSR_TYPE_L3.", 
      "required": false, 
      "title": "Dsr type"
    }
  }, 
  "title": "DsrProfile", 
  "type": "object"
}

ALBDsrType (type)

{
  "description": "Valid ENUM values for ALBDsrType", 
  "enum": [
    "DSR_TYPE_L2", 
    "DSR_TYPE_L3"
  ], 
  "id": "ALBDsrType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "DsrType type", 
  "type": "string"
}

ALBEncapType (type)

{
  "description": "Valid ENUM values for ALBEncapType", 
  "enum": [
    "ENCAP_IPINIP"
  ], 
  "id": "ALBEncapType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "EncapType type", 
  "type": "string"
}

ALBEnforcementPointState (type)

{
  "description": "Valid ENUM values for ALBEnforcementPointState", 
  "enum": [
    "ACTIVATE", 
    "DEACTIVATE_PROVIDER", 
    "DEACTIVATE_API"
  ], 
  "id": "ALBEnforcementPointState", 
  "module_id": "PolicyEnforcementPointManagement", 
  "title": "Enforcement point state for ALB", 
  "type": "string"
}

ALBEquivalentLabels (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer EquivalentLabels object", 
  "id": "ALBEquivalentLabels", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "labels": {
      "description": "Equivalent labels.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Labels", 
      "type": "array"
    }
  }, 
  "title": "EquivalentLabels", 
  "type": "object"
}

ALBErrorPage (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ErrorPage object", 
  "id": "ALBErrorPage", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable": {
      "default": true, 
      "description": "Enable or disable the error page. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "error_page_body_path": {
      "description": "Custom error page body used to sent to the client. It is a reference to an object of type ErrorPageBody.", 
      "required": false, 
      "title": "Error page body path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBErrorPageProfile"
          ], 
          "relationshipType": "ALB_ERRORPAGEPROFILE_ALB_ERRORPAGEBODY_RELATIONSHIP", 
          "rightType": [
            "ALBErrorPageBody"
          ]
        }
      ]
    }, 
    "error_redirect": {
      "description": "Redirect sent to client when match.", 
      "required": false, 
      "title": "Error redirect", 
      "type": "string"
    }, 
    "index": {
      "description": "Index of the error page.", 
      "required": false, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBHTTPStatusMatch, 
      "description": "Add match criteria for http status codes to the error page. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Match"
    }
  }, 
  "title": "ErrorPage", 
  "type": "object"
}

ALBErrorPageBody (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ErrorPageBody object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBErrorPageBody", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_page_body": {
      "description": "Error page body sent to client when match.", 
      "required": false, 
      "title": "Error page body", 
      "type": "string"
    }, 
    "format": {
      "$ref": "ALBErrorPageFormat, 
      "default": "ERROR_PAGE_FORMAT_HTML", 
      "description": "Format of an error page body HTML or JSON. Enum options - ERROR_PAGE_FORMAT_HTML, ERROR_PAGE_FORMAT_JSON. Default value when not specified in API or module is interpreted by ALB Controller as ERROR_PAGE_FORMAT_HTML.", 
      "required": false, 
      "title": "Format"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "ErrorPageBody", 
  "type": "object"
}

ALBErrorPageBodyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ErrorPageBodyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBErrorPageBodyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ErrorPageBody", 
      "items": {
        "$ref": "ALBErrorPageBody
      }, 
      "required": false, 
      "title": "Array of ErrorPageBody", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ErrorPageBodyApiResponse", 
  "type": "object"
}

ALBErrorPageFormat (type)

{
  "description": "Valid ENUM values for ALBErrorPageFormat", 
  "enum": [
    "ERROR_PAGE_FORMAT_HTML", 
    "ERROR_PAGE_FORMAT_JSON"
  ], 
  "id": "ALBErrorPageFormat", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ErrorPageFormat type", 
  "type": "string"
}

ALBErrorPageProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ErrorPageProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBErrorPageProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_pages": {
      "description": "Defined Error Pages for HTTP status codes.", 
      "items": {
        "$ref": "ALBErrorPage
      }, 
      "required": false, 
      "title": "Error pages", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "ErrorPageProfile", 
  "type": "object"
}

ALBErrorPageProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ErrorPageProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBErrorPageProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ErrorPageProfile", 
      "items": {
        "$ref": "ALBErrorPageProfile
      }, 
      "required": false, 
      "title": "Array of ErrorPageProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ErrorPageProfileApiResponse", 
  "type": "object"
}

ALBFailAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer FailAction object", 
  "id": "ALBFailAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "local_rsp": {
      "$ref": "ALBFailActionHTTPLocalResponse, 
      "description": "Local response to HTTP requests when pool experiences a failure.", 
      "required": false, 
      "title": "Local rsp"
    }, 
    "redirect": {
      "$ref": "ALBFailActionHTTPRedirect, 
      "description": "URL to redirect HTTP requests to when pool experiences a failure.", 
      "required": false, 
      "title": "Redirect"
    }, 
    "type": {
      "$ref": "ALBFailActionEnum, 
      "default": "FAIL_ACTION_CLOSE_CONN", 
      "description": "Enables a response to client when pool experiences a failure. By default TCP connection is closed. Enum options - FAIL_ACTION_HTTP_REDIRECT, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_CLOSE_CONN. Allowed in Basic(Allowed values- FAIL_ACTION_CLOSE_CONN,FAIL_ACTION_HTTP_REDIRECT) edition, Essentials(Allowed values- FAIL_ACTION_CLOSE_CONN) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as FAIL_ACTION_CLOSE_CONN.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "FailAction", 
  "type": "object"
}

ALBFailActionEnum (type)

{
  "description": "Valid ENUM values for ALBFailActionEnum", 
  "enum": [
    "FAIL_ACTION_HTTP_REDIRECT", 
    "FAIL_ACTION_HTTP_LOCAL_RSP", 
    "FAIL_ACTION_CLOSE_CONN"
  ], 
  "id": "ALBFailActionEnum", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "FailActionEnum type", 
  "type": "string"
}

ALBFailActionHTTPLocalResponse (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer FailActionHTTPLocalResponse object", 
  "id": "ALBFailActionHTTPLocalResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "file": {
      "$ref": "ALBHTTPLocalFile, 
      "description": "Placeholder for description of property file of obj type FailActionHTTPLocalResponse field type str  type ref.", 
      "required": false, 
      "title": "File"
    }, 
    "status_code": {
      "$ref": "ALBFailHttpStatusCode, 
      "default": "FAIL_HTTP_STATUS_CODE_503", 
      "description": "Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503. Default value when not specified in API or module is interpreted by ALB Controller as FAIL_HTTP_STATUS_CODE_503.", 
      "required": false, 
      "title": "Status code"
    }
  }, 
  "title": "FailActionHTTPLocalResponse", 
  "type": "object"
}

ALBFailActionHTTPRedirect (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer FailActionHTTPRedirect object", 
  "id": "ALBFailActionHTTPRedirect", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host": {
      "description": "host of FailActionHTTPRedirect.", 
      "required": true, 
      "title": "Host", 
      "type": "string"
    }, 
    "path": {
      "description": "path of FailActionHTTPRedirect.", 
      "required": false, 
      "title": "Path", 
      "type": "string"
    }, 
    "protocol": {
      "$ref": "ALBHTTPProtocol, 
      "default": "HTTP", 
      "description": "Enum options - HTTP, HTTPS. Allowed in Basic(Allowed values- HTTP) edition, Enterprise edition. Special default for Basic edition is HTTP, Enterprise is HTTPS. Default value when not specified in API or module is interpreted by ALB Controller as HTTP.", 
      "required": false, 
      "title": "Protocol"
    }, 
    "query": {
      "description": "query of FailActionHTTPRedirect.", 
      "required": false, 
      "title": "Query", 
      "type": "string"
    }, 
    "status_code": {
      "$ref": "ALBHTTPRedirectStatusCode, 
      "default": "HTTP_REDIRECT_STATUS_CODE_302", 
      "description": "Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Allowed in Basic(Allowed values- HTTP_REDIRECT_STATUS_CODE_302) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_REDIRECT_STATUS_CODE_302.", 
      "required": false, 
      "title": "Status code"
    }
  }, 
  "title": "FailActionHTTPRedirect", 
  "type": "object"
}

ALBFailHttpStatusCode (type)

{
  "description": "Valid ENUM values for ALBFailHttpStatusCode", 
  "enum": [
    "FAIL_HTTP_STATUS_CODE_200", 
    "FAIL_HTTP_STATUS_CODE_503"
  ], 
  "id": "ALBFailHttpStatusCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "FailHttpStatusCode type", 
  "type": "string"
}

ALBFlowLabelType (type)

{
  "description": "Valid ENUM values for ALBFlowLabelType", 
  "enum": [
    "NO_LABEL", 
    "APPLICATION_LABEL", 
    "SERVICE_LABEL"
  ], 
  "id": "ALBFlowLabelType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "FlowLabelType type", 
  "type": "string"
}

ALBFullClientLogs (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer FullClientLogs object", 
  "id": "ALBFullClientLogs", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "duration": {
      "default": 30, 
      "description": "How long should the system capture all logs, measured in minutes. Set to 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "required": false, 
      "title": "Duration", 
      "type": "integer"
    }, 
    "enabled": {
      "default": false, 
      "description": "Capture all client logs including connections and requests. When deactivated, only errors will be logged. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is False. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "throttle": {
      "default": 10, 
      "description": "This setting limits the number of non-significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Unit is PER_SECOND. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "required": false, 
      "title": "Throttle", 
      "type": "integer"
    }
  }, 
  "title": "FullClientLogs", 
  "type": "object"
}

ALBGeoLocation (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer GeoLocation object", 
  "id": "ALBGeoLocation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "latitude": {
      "description": "Latitude of the location. This is represented as degrees.minutes. The range is from -90.0 (south) to +90.0 (north). Allowed values are -90.0-+90.0.", 
      "required": false, 
      "title": "Latitude", 
      "type": "number"
    }, 
    "longitude": {
      "description": "Longitude of the location. This is represented as degrees.minutes. The range is from -180.0 (west) to +180.0 (east). Allowed values are -180.0-+180.0.", 
      "required": false, 
      "title": "Longitude", 
      "type": "number"
    }, 
    "name": {
      "description": "Location name in the format Country/State/City.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "tag": {
      "description": "Location tag string - example  USEast.", 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }
  }, 
  "title": "GeoLocation", 
  "type": "object"
}

ALBHSMAwsCloudHsm (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMAwsCloudHsm object", 
  "id": "ALBHSMAwsCloudHsm", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_config": {
      "description": "client_config of HSMAwsCloudHsm.", 
      "required": false, 
      "title": "Client config", 
      "type": "string"
    }, 
    "cluster_cert": {
      "description": "AWS CloudHSM Cluster Certificate.", 
      "required": false, 
      "title": "Cluster cert", 
      "type": "string"
    }, 
    "crypto_user_name": {
      "description": "Username of the Crypto User. This will be used to access the keys on the HSM .", 
      "required": false, 
      "title": "Crypto user name", 
      "type": "string"
    }, 
    "crypto_user_password": {
      "description": "Password of the Crypto User. This will be used to access the keys on the HSM .", 
      "required": false, 
      "sensitive": true, 
      "title": "Crypto user password", 
      "type": "secure_string"
    }, 
    "hsm_ip": {
      "description": "IP address of the HSM in the cluster. If there are more than one HSMs, only one is sufficient.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Hsm ip", 
      "type": "array"
    }, 
    "mgmt_config": {
      "description": "mgmt_config of HSMAwsCloudHsm.", 
      "required": false, 
      "title": "Mgmt config", 
      "type": "string"
    }
  }, 
  "title": "HSMAwsCloudHsm", 
  "type": "object"
}

ALBHSMSafenetClientInfo (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMSafenetClientInfo object", 
  "id": "ALBHSMSafenetClientInfo", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "chrystoki_conf": {
      "description": "Generated File - Chrystoki.conf .", 
      "required": false, 
      "title": "Chrystoki conf", 
      "type": "string"
    }, 
    "client_cert": {
      "description": "Client Certificate generated by createCert.", 
      "required": false, 
      "title": "Client cert", 
      "type": "string"
    }, 
    "client_ip": {
      "description": "Name prepended to client key and certificate filename.", 
      "required": true, 
      "title": "Client ip", 
      "type": "string"
    }, 
    "client_priv_key": {
      "description": "Client Private Key generated by createCert.", 
      "required": false, 
      "sensitive": true, 
      "title": "Client priv key", 
      "type": "secure_string"
    }, 
    "session_major_number": {
      "description": "Major number of the sesseion.", 
      "required": false, 
      "title": "Session major number", 
      "type": "integer"
    }, 
    "session_minor_number": {
      "description": "Minor number of the sesseion.", 
      "required": false, 
      "title": "Session minor number", 
      "type": "integer"
    }
  }, 
  "title": "HSMSafenetClientInfo", 
  "type": "object"
}

ALBHSMSafenetLuna (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMSafenetLuna object", 
  "id": "ALBHSMSafenetLuna", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ha_group_num": {
      "description": "Group Number of generated HA Group.", 
      "required": false, 
      "title": "Ha group num", 
      "type": "integer"
    }, 
    "is_ha": {
      "default": false, 
      "description": "Set to indicate HA across more than one servers. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Is ha", 
      "type": "boolean"
    }, 
    "node_info": {
      "description": "Node specific information.", 
      "items": {
        "$ref": "ALBHSMSafenetClientInfo
      }, 
      "required": false, 
      "title": "Node info", 
      "type": "array"
    }, 
    "server": {
      "description": "SafeNet/Gemalto HSM Servers used for crypto operations.", 
      "items": {
        "$ref": "ALBHSMSafenetLunaServer
      }, 
      "required": false, 
      "title": "Server", 
      "type": "array"
    }, 
    "server_pem": {
      "description": "Generated File - server.pem.", 
      "required": false, 
      "title": "Server pem", 
      "type": "string"
    }, 
    "use_dedicated_network": {
      "default": false, 
      "description": "If enabled, dedicated network is used to communicate with HSM,else, the management network is used. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use dedicated network", 
      "type": "boolean"
    }
  }, 
  "title": "HSMSafenetLuna", 
  "type": "object"
}

ALBHSMSafenetLunaServer (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMSafenetLunaServer object", 
  "id": "ALBHSMSafenetLunaServer", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "partition_passwd": {
      "description": "Password of the partition assigned to this client.", 
      "required": false, 
      "sensitive": true, 
      "title": "Partition passwd", 
      "type": "secure_string"
    }, 
    "partition_serial_number": {
      "description": "Serial number of the partition assigned to this client.", 
      "required": false, 
      "title": "Partition serial number", 
      "type": "string"
    }, 
    "remote_ip": {
      "description": "IP address of the Safenet/Gemalto HSM device.", 
      "required": true, 
      "title": "Remote ip", 
      "type": "string"
    }, 
    "server_cert": {
      "description": "CA certificate of the server.", 
      "required": true, 
      "title": "Server cert", 
      "type": "string"
    }
  }, 
  "title": "HSMSafenetLunaServer", 
  "type": "object"
}

ALBHSMThalesNetHsm (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMThalesNetHsm object", 
  "id": "ALBHSMThalesNetHsm", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "esn": {
      "description": "Electronic serial number of the netHSM device. Use Thales anonkneti utility to find the netHSM ESN.", 
      "required": true, 
      "title": "Esn", 
      "type": "string"
    }, 
    "keyhash": {
      "description": "Hash of the key that netHSM device uses to authenticate itself. Use Thales anonkneti utility to find the netHSM keyhash.", 
      "required": true, 
      "title": "Keyhash", 
      "type": "string"
    }, 
    "module_id": {
      "default": 0, 
      "description": "Local module id of the netHSM device. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Module id", 
      "type": "integer"
    }, 
    "priority": {
      "default": 100, 
      "description": "Priority class of the nethsm in an high availability setup. 1 is the highest priority and 100 is the lowest priority. Allowed values are 1-100. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": true, 
      "title": "Priority", 
      "type": "integer"
    }, 
    "remote_ip": {
      "$ref": "ALBIpAddr, 
      "description": "IP address of the netHSM device.", 
      "required": true, 
      "title": "Remote ip"
    }, 
    "remote_port": {
      "default": 9004, 
      "description": "Port at which the netHSM device accepts the connection. Allowed values are 1-65535. Default value when not specified in API or module is interpreted by ALB Controller as 9004.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Remote port", 
      "type": "integer"
    }
  }, 
  "title": "HSMThalesNetHsm", 
  "type": "object"
}

ALBHSMThalesRFS (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HSMThalesRFS object", 
  "id": "ALBHSMThalesRFS", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip": {
      "$ref": "ALBIpAddr, 
      "description": "IP address of the RFS server from where to sync the Thales encrypted private key.", 
      "required": true, 
      "title": "Ip"
    }, 
    "port": {
      "default": 9004, 
      "description": "Port at which the RFS server accepts the sync request from clients for Thales encrypted private key. Allowed values are 1-65535. Default value when not specified in API or module is interpreted by ALB Controller as 9004.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }
  }, 
  "title": "HSMThalesRFS", 
  "type": "object"
}

ALBHSMType (type)

{
  "description": "Valid ENUM values for ALBHSMType", 
  "enum": [
    "HSM_TYPE_THALES_NETHSM", 
    "HSM_TYPE_SAFENET_LUNA", 
    "HSM_TYPE_AWS_CLOUDHSM"
  ], 
  "id": "ALBHSMType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HSMType type", 
  "type": "string"
}

ALBHTTP2ApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTP2ApplicationProfile object", 
  "id": "ALBHTTP2ApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "http2_initial_window_size": {
      "default": 64, 
      "description": "The initial flow control window size in KB for HTTP/2 streams. Allowed values are 64-32768. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 64.", 
      "maximum": 32768, 
      "minimum": 64, 
      "required": false, 
      "title": "Http2 initial window size", 
      "type": "integer"
    }, 
    "max_http2_concurrent_streams_per_connection": {
      "default": 128, 
      "description": "The max number of concurrent streams over a client side HTTP/2 connection. Allowed values are 1-256. Default value when not specified in API or module is interpreted by ALB Controller as 128.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Max http2 concurrent streams per connection", 
      "type": "integer"
    }, 
    "max_http2_control_frames_per_connection": {
      "default": 1000, 
      "description": "The max number of control frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited control frames on a client side HTTP/2 connection'. Default value when not specified in API or module is interpreted by ALB Controller as 1000.", 
      "maximum": 10000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max http2 control frames per connection", 
      "type": "integer"
    }, 
    "max_http2_empty_data_frames_per_connection": {
      "default": 1000, 
      "description": "The max number of empty data frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited empty data frames over a client side HTTP/2 connection'. Default value when not specified in API or module is interpreted by ALB Controller as 1000.", 
      "maximum": 10000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max http2 empty data frames per connection", 
      "type": "integer"
    }, 
    "max_http2_header_field_size": {
      "default": 4096, 
      "description": "The maximum size in bytes of the compressed request header field. The limit applies equally to both name and value. Allowed values are 1-8192. Unit is BYTES. Default value when not specified in API or module is interpreted by ALB Controller as 4096.", 
      "maximum": 8192, 
      "minimum": 1, 
      "required": false, 
      "title": "Max http2 header field size", 
      "type": "integer"
    }, 
    "max_http2_queued_frames_to_client_per_connection": {
      "default": 1000, 
      "description": "The max number of frames that can be queued waiting to be sent over a client side HTTP/2 connection at any given time. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited frames can be queued on a client side HTTP/2 connection'. Default value when not specified in API or module is interpreted by ALB Controller as 1000.", 
      "maximum": 10000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max http2 queued frames to client per connection", 
      "type": "integer"
    }, 
    "max_http2_requests_per_connection": {
      "default": 1000, 
      "description": "The maximum number of requests over a client side HTTP/2 connection. Allowed values are 0-10000. Special values are 0- 'Unlimited requests on a client side HTTP/2 connection'. Default value when not specified in API or module is interpreted by ALB Controller as 1000.", 
      "maximum": 10000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max http2 requests per connection", 
      "type": "integer"
    }
  }, 
  "title": "HTTP2ApplicationProfile", 
  "type": "object"
}

ALBHTTPApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPApplicationProfile object", 
  "id": "ALBHTTPApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "allow_dots_in_header_name": {
      "default": false, 
      "description": "Allow use of dot (.) in HTTP header names, for instance Header.app.special  PickAppVersionX. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Allow dots in header name", 
      "type": "boolean"
    }, 
    "cache_config": {
      "$ref": "ALBHttpCacheConfig, 
      "description": "HTTP Caching config to use with this HTTP Profile.", 
      "required": false, 
      "title": "Cache config"
    }, 
    "client_body_timeout": {
      "default": 30000, 
      "description": "The maximum length of time allowed between consecutive read operations for a client request body. The value '0' specifies no timeout. This setting generally impacts the length of time allowed for a client to send a POST. Allowed values are 0-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 30000) edition, Essentials(Allowed values- 30000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 30000.", 
      "maximum": 100000000, 
      "minimum": 0, 
      "required": false, 
      "title": "Client body timeout", 
      "type": "integer"
    }, 
    "client_header_timeout": {
      "default": 10000, 
      "description": "The maximum length of time allowed for a client to transmit an entire request header. This helps mitigate various forms of SlowLoris attacks. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 10000) edition, Essentials(Allowed values- 10000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 10000.", 
      "maximum": 100000000, 
      "minimum": 10, 
      "required": false, 
      "title": "Client header timeout", 
      "type": "integer"
    }, 
    "client_max_body_size": {
      "default": 0, 
      "description": "Maximum size for the client request body. This limits the size of the client data that can be uploaded/posted as part of a single HTTP Request. Default 0 => Unlimited. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Client max body size", 
      "type": "integer"
    }, 
    "client_max_header_size": {
      "default": 12, 
      "description": "Maximum size in Kbytes of a single HTTP header in the client request. Allowed values are 1-64. Unit is KB. Allowed in Basic(Allowed values- 12) edition, Essentials(Allowed values- 12) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 12.", 
      "maximum": 64, 
      "minimum": 1, 
      "required": false, 
      "title": "Client max header size", 
      "type": "integer"
    }, 
    "client_max_request_size": {
      "default": 48, 
      "description": "Maximum size in Kbytes of all the client HTTP request headers. Allowed values are 1-256. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 48.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Client max request size", 
      "type": "integer"
    }, 
    "compression_profile": {
      "$ref": "ALBCompressionProfile, 
      "description": "HTTP Compression settings to use with this HTTP Profile.", 
      "required": false, 
      "title": "Compression profile"
    }, 
    "connection_multiplexing_enabled": {
      "default": true, 
      "description": "Allows HTTP requests, not just TCP connections, to be load balanced across servers. Proxied TCP connections to servers may be reused by multiple clients to improve performance. Not compatible with Preserve Client IP. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Connection multiplexing enabled", 
      "type": "boolean"
    }, 
    "disable_keepalive_posts_msie6": {
      "default": true, 
      "description": "Disable keep-alive client side connections for older browsers based off MS Internet Explorer 6.0 (MSIE6). For some applications, this might break NTLM authentication for older clients based off MSIE6. For such applications, set this option to false to allow keep-alive connections. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Disable keepalive posts msie6", 
      "type": "boolean"
    }, 
    "disable_sni_hostname_check": {
      "default": false, 
      "description": "Disable strict check between TLS servername and HTTP Host name. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Disable sni hostname check", 
      "type": "boolean"
    }, 
    "enable_chunk_merge": {
      "default": true, 
      "description": "Enable chunk body merge for chunked transfer encoding response. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable chunk merge", 
      "type": "boolean"
    }, 
    "enable_fire_and_forget": {
      "default": false, 
      "description": "Enable support for fire and forget feature. If enabled, request from client is forwarded to server even if client prematurely closes the connection. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable fire and forget", 
      "type": "boolean"
    }, 
    "enable_request_body_buffering": {
      "default": false, 
      "description": "Enable request body buffering for POST requests. If enabled, max buffer size is set to lower of 32M or the value (non-zero) configured in client_max_body_size. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable request body buffering", 
      "type": "boolean"
    }, 
    "enable_request_body_metrics": {
      "default": false, 
      "description": "Enable HTTP request body metrics. If enabled, requests from clients are parsed and relevant statistics about them are gathered. Currently, it processes HTTP POST requests with Content-Type application/x-www-form-urlencoded or multipart/form-data, and adds the number of detected parameters to the l7_client.http_params_count. This is an experimental feature and it may have performance impact. Use it when detailed information about the number of HTTP POST parameters is needed, e.g. for WAF sizing. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable request body metrics", 
      "type": "boolean"
    }, 
    "fwd_close_hdr_for_bound_connections": {
      "default": true, 
      "description": "Forward the Connection  Close header coming from backend server to the client if connection-switching is enabled, i.e. front-end and backend connections are bound together. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Fwd close hdr for bound connections", 
      "type": "boolean"
    }, 
    "hsts_enabled": {
      "default": false, 
      "description": "Inserts HTTP Strict-Transport-Security header in the HTTPS response. HSTS can help mitigate man-in-the-middle attacks by telling browsers that support HSTS that they should only access this site via HTTPS. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Hsts enabled", 
      "type": "boolean"
    }, 
    "hsts_max_age": {
      "default": 365, 
      "description": "Number of days for which the client should regard this virtual service as a known HSTS host. Allowed values are 0-10000. Allowed in Basic(Allowed values- 365) edition, Essentials(Allowed values- 365) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 365.", 
      "maximum": 10000, 
      "minimum": 0, 
      "required": false, 
      "title": "Hsts max age", 
      "type": "integer"
    }, 
    "hsts_subdomains_enabled": {
      "default": false, 
      "description": "Insert the 'includeSubdomains' directive in the HTTP Strict-Transport-Security header. Adding the includeSubdomains directive signals the User-Agent that the HSTS Policy applies to this HSTS Host as well as any subdomains of the host's domain name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Hsts subdomains enabled", 
      "type": "boolean"
    }, 
    "http2_profile": {
      "$ref": "ALBHTTP2ApplicationProfile, 
      "description": "Specifies the HTTP/2 specific application profile parameters. Allowed in Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Http2 profile"
    }, 
    "http_to_https": {
      "default": false, 
      "description": "Client requests received via HTTP will be redirected to HTTPS. Allowed in Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Http to https", 
      "type": "boolean"
    }, 
    "http_upstream_buffer_size": {
      "default": 0, 
      "description": "Size of HTTP buffer in kB. Allowed values are 1-256. Special values are 0- 'Auto compute the size of buffer'. Unit is KB. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 256, 
      "minimum": 0, 
      "required": false, 
      "title": "Http upstream buffer size", 
      "type": "integer"
    }, 
    "httponly_enabled": {
      "default": false, 
      "description": "Mark HTTP cookies as HTTPonly. This helps mitigate cross site scripting attacks as browsers will not allow these cookies to be read by third parties, such as javascript. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Httponly enabled", 
      "type": "boolean"
    }, 
    "keepalive_header": {
      "default": false, 
      "description": "Send HTTP 'Keep-Alive' header to the client. By default, the timeout specified in the 'Keep-Alive Timeout' field will be used unless the 'Use App Keepalive Timeout' flag is set, in which case the timeout sent by the application will be honored. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Keepalive header", 
      "type": "boolean"
    }, 
    "keepalive_timeout": {
      "default": 30000, 
      "description": "The max idle time allowed between HTTP requests over a Keep-alive connection. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Essentials(Allowed values- 30000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 30000.", 
      "maximum": 100000000, 
      "minimum": 10, 
      "required": false, 
      "title": "Keepalive timeout", 
      "type": "integer"
    }, 
    "max_bad_rps_cip": {
      "default": 0, 
      "description": "Maximum bad requests per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max bad rps cip", 
      "type": "integer"
    }, 
    "max_bad_rps_cip_uri": {
      "default": 0, 
      "description": "Maximum bad requests per second per client IP and URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max bad rps cip uri", 
      "type": "integer"
    }, 
    "max_bad_rps_uri": {
      "default": 0, 
      "description": "Maximum bad requests per second per URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max bad rps uri", 
      "type": "integer"
    }, 
    "max_keepalive_requests": {
      "default": 100, 
      "description": "The max number of HTTP requests that can be sent over a Keep-Alive connection. '0' means unlimited. Allowed values are 0-1000000. Special values are 0- 'Unlimited requests on a connection'. Allowed in Basic(Allowed values- 100) edition, Essentials(Allowed values- 100) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 1000000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max keepalive requests", 
      "type": "integer"
    }, 
    "max_response_headers_size": {
      "default": 48, 
      "description": "Maximum size in Kbytes of all the HTTP response headers. Allowed values are 1-256. Unit is KB. Allowed in Basic(Allowed values- 48) edition, Essentials(Allowed values- 48) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 48.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Max response headers size", 
      "type": "integer"
    }, 
    "max_rps_cip": {
      "default": 0, 
      "description": "Maximum requests per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max rps cip", 
      "type": "integer"
    }, 
    "max_rps_cip_uri": {
      "default": 0, 
      "description": "Maximum requests per second per client IP and URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max rps cip uri", 
      "type": "integer"
    }, 
    "max_rps_unknown_cip": {
      "default": 0, 
      "description": "Maximum unknown client IPs per second. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max rps unknown cip", 
      "type": "integer"
    }, 
    "max_rps_unknown_uri": {
      "default": 0, 
      "description": "Maximum unknown URIs per second. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max rps unknown uri", 
      "type": "integer"
    }, 
    "max_rps_uri": {
      "default": 0, 
      "description": "Maximum requests per second per URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max rps uri", 
      "type": "integer"
    }, 
    "pki_profile_path": {
      "description": "Select the PKI profile to be associated with the Virtual Service. This profile defines the Certificate Authority and Revocation List. It is a reference to an object of type PKIProfile.", 
      "required": false, 
      "title": "Pki profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_PKIPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBPKIProfile"
          ]
        }
      ]
    }, 
    "post_accept_timeout": {
      "default": 30000, 
      "description": "The max allowed length of time between a client establishing a TCP connection and Avi receives the first byte of the client's HTTP request. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 30000) edition, Essentials(Allowed values- 30000) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 30000.", 
      "maximum": 100000000, 
      "minimum": 10, 
      "required": false, 
      "title": "Post accept timeout", 
      "type": "integer"
    }, 
    "reset_conn_http_on_ssl_port": {
      "default": false, 
      "description": "If enabled, an HTTP request on an SSL port will result in connection close instead of a 400 response. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Reset conn http on ssl port", 
      "type": "boolean"
    }, 
    "respond_with_100_continue": {
      "default": true, 
      "description": "Avi will respond with 100-Continue response if Expect  100-Continue header received from client. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Respond with 100 continue", 
      "type": "boolean"
    }, 
    "secure_cookie_enabled": {
      "default": false, 
      "description": "Mark server cookies with the 'Secure' attribute. Client browsers will not send a cookie marked as secure over an unencrypted connection. If Avi is terminating SSL from clients and passing it as HTTP to the server, the server may return cookies without the secure flag set. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Secure cookie enabled", 
      "type": "boolean"
    }, 
    "server_side_redirect_to_https": {
      "default": false, 
      "description": "When terminating client SSL sessions at Avi, servers may incorrectly send redirect to clients as HTTP. This option will rewrite the server's redirect responses for this virtual service from HTTP to HTTPS. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Server side redirect to https", 
      "type": "boolean"
    }, 
    "ssl_client_certificate_action": {
      "$ref": "ALBSSLClientCertificateAction, 
      "description": "Set of match/action rules that govern what happens when the client certificate request is enabled.", 
      "required": false, 
      "title": "Ssl client certificate action"
    }, 
    "ssl_client_certificate_mode": {
      "$ref": "ALBSSLClientCertificateMode, 
      "default": "SSL_CLIENT_CERTIFICATE_NONE", 
      "description": "Specifies whether the client side verification is set to none, request or require. Enum options - SSL_CLIENT_CERTIFICATE_NONE, SSL_CLIENT_CERTIFICATE_REQUEST, SSL_CLIENT_CERTIFICATE_REQUIRE. Allowed in Basic(Allowed values- SSL_CLIENT_CERTIFICATE_NONE,SSL_CLIENT_CERTIFICATE_REQUIRE) edition, Essentials(Allowed values- SSL_CLIENT_CERTIFICATE_NONE,SSL_CLIENT_CERTIFICATE_REQUIRE) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CLIENT_CERTIFICATE_NONE.", 
      "required": false, 
      "title": "Ssl client certificate mode"
    }, 
    "use_app_keepalive_timeout": {
      "default": false, 
      "description": "Use 'Keep-Alive' header timeout sent by application instead of sending the HTTP Keep-Alive Timeout. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use app keepalive timeout", 
      "type": "boolean"
    }, 
    "websockets_enabled": {
      "default": true, 
      "description": "Enable Websockets proxy for traffic from clients to the virtual service. Connections to this VS start in HTTP mode. If the client requests an Upgrade to Websockets, and the server responds back with success, then the connection is upgraded to WebSockets mode. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Websockets enabled", 
      "type": "boolean"
    }, 
    "x_forwarded_proto_enabled": {
      "default": false, 
      "description": "Insert an X-Forwarded-Proto header in the request sent to the server. When the client connects via SSL, Avi terminates the SSL, and then forwards the requests to the servers via HTTP, so the servers can determine the original protocol via this header. In this example, the value will be 'https'. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "X forwarded proto enabled", 
      "type": "boolean"
    }, 
    "xff_alternate_name": {
      "default": "X-Forwarded-For", 
      "description": "Provide a custom name for the X-Forwarded-For header sent to the servers. Default value when not specified in API or module is interpreted by ALB Controller as X-Forwarded-For.", 
      "required": false, 
      "title": "Xff alternate name", 
      "type": "string"
    }, 
    "xff_enabled": {
      "default": true, 
      "description": "The client's original IP address is inserted into an HTTP request header sent to the server. Servers may use this address for logging or other purposes, rather than Avi's source NAT address used in the Avi to server IP connection. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Xff enabled", 
      "type": "boolean"
    }
  }, 
  "title": "HTTPApplicationProfile", 
  "type": "object"
}

ALBHTTPClientAuthenticationParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPClientAuthenticationParams object", 
  "id": "ALBHTTPClientAuthenticationParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "auth_profile_path": {
      "description": "Auth Profile to use for validating users. It is a reference to an object of type AuthProfile.", 
      "required": false, 
      "title": "Auth profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_AUTHPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBAuthProfile"
          ]
        }
      ]
    }, 
    "realm": {
      "description": "Basic authentication realm to present to a user along with the prompt for credentials.", 
      "required": false, 
      "title": "Realm", 
      "type": "string"
    }, 
    "request_uri_path": {
      "$ref": "ALBStringMatch, 
      "description": "Rrequest URI path when the authentication applies.", 
      "required": false, 
      "title": "Request uri path"
    }, 
    "type": {
      "$ref": "ALBHTTPClientAuthenticationType, 
      "description": "type of client authentication. Enum options - HTTP_BASIC_AUTH.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "HTTPClientAuthenticationParams", 
  "type": "object"
}

ALBHTTPClientAuthenticationType (type)

{
  "description": "Valid ENUM values for ALBHTTPClientAuthenticationType", 
  "enum": [
    "HTTP_BASIC_AUTH"
  ], 
  "id": "ALBHTTPClientAuthenticationType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPClientAuthenticationType type", 
  "type": "string"
}

ALBHTTPCookieData (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPCookieData object", 
  "id": "ALBHTTPCookieData", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "name": {
      "description": "Cookie name.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "value": {
      "description": "Cookie value.", 
      "required": false, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "HTTPCookieData", 
  "type": "object"
}

ALBHTTPHdrAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPHdrAction object", 
  "id": "ALBHTTPHdrAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBHTTPHdrActionType, 
      "description": "ADD  A new header with the new value is added irrespective of the existence of an HTTP header of the given name. REPLACE  A new header with the new value is added if no header of the given name exists, else existing headers with the given name are removed and a new header with the new value is added. REMOVE  All the headers of the given name are removed. Enum options - HTTP_ADD_HDR, HTTP_REMOVE_HDR, HTTP_REPLACE_HDR. Allowed in Basic(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Essentials(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Enterprise edition.", 
      "required": true, 
      "title": "Action"
    }, 
    "cookie": {
      "$ref": "ALBHTTPCookieData, 
      "description": "Cookie information.", 
      "required": false, 
      "title": "Cookie"
    }, 
    "hdr": {
      "$ref": "ALBHTTPHdrData, 
      "description": "HTTP header information.", 
      "required": false, 
      "title": "Hdr"
    }
  }, 
  "title": "HTTPHdrAction", 
  "type": "object"
}

ALBHTTPHdrActionType (type)

{
  "description": "Valid ENUM values for ALBHTTPHdrActionType", 
  "enum": [
    "HTTP_ADD_HDR", 
    "HTTP_REMOVE_HDR", 
    "HTTP_REPLACE_HDR"
  ], 
  "id": "ALBHTTPHdrActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPHdrActionType type", 
  "type": "string"
}

ALBHTTPHdrData (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPHdrData object", 
  "id": "ALBHTTPHdrData", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "name": {
      "description": "HTTP header name.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "value": {
      "$ref": "ALBHTTPHdrValue, 
      "description": "HTTP header value.", 
      "required": false, 
      "title": "Value"
    }
  }, 
  "title": "HTTPHdrData", 
  "type": "object"
}

ALBHTTPHdrValue (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPHdrValue object", 
  "id": "ALBHTTPHdrValue", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "val": {
      "description": "HTTP header value or variable representing an HTTP header.", 
      "required": false, 
      "title": "Val", 
      "type": "string"
    }, 
    "var": {
      "$ref": "ALBHTTPPolicyVar, 
      "description": "Variable. Enum options - HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_REQUEST_ID, HTTP_POLICY_VAR_SSL_CLIENT_VERSION, HTTP_POLICY_VAR_SSL_CLIENT_SIGALG, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDBEFORE, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDAFTER.", 
      "required": false, 
      "title": "Var"
    }
  }, 
  "title": "HTTPHdrValue", 
  "type": "object"
}

ALBHTTPLocalFile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPLocalFile object", 
  "id": "ALBHTTPLocalFile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "content_type": {
      "description": "Mime-type of the content in the file.", 
      "required": true, 
      "title": "Content type", 
      "type": "string"
    }, 
    "file_content": {
      "description": "File content to used in the local HTTP response body.", 
      "required": true, 
      "title": "File content", 
      "type": "string"
    }
  }, 
  "title": "HTTPLocalFile", 
  "type": "object"
}

ALBHTTPLocalResponseStatusCode (type)

{
  "description": "Valid ENUM values for ALBHTTPLocalResponseStatusCode", 
  "enum": [
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_200", 
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_204", 
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_403", 
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_404", 
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_429", 
    "HTTP_LOCAL_RESPONSE_STATUS_CODE_501"
  ], 
  "id": "ALBHTTPLocalResponseStatusCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPLocalResponseStatusCode type", 
  "type": "string"
}

ALBHTTPMethod (type)

{
  "description": "Valid ENUM values for ALBHTTPMethod", 
  "enum": [
    "HTTP_METHOD_GET", 
    "HTTP_METHOD_HEAD", 
    "HTTP_METHOD_PUT", 
    "HTTP_METHOD_DELETE", 
    "HTTP_METHOD_POST", 
    "HTTP_METHOD_OPTIONS", 
    "HTTP_METHOD_TRACE", 
    "HTTP_METHOD_CONNECT", 
    "HTTP_METHOD_PATCH", 
    "HTTP_METHOD_PROPFIND", 
    "HTTP_METHOD_PROPPATCH", 
    "HTTP_METHOD_MKCOL", 
    "HTTP_METHOD_COPY", 
    "HTTP_METHOD_MOVE", 
    "HTTP_METHOD_LOCK", 
    "HTTP_METHOD_UNLOCK"
  ], 
  "id": "ALBHTTPMethod", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPMethod type", 
  "type": "string"
}

ALBHTTPPolicies (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPPolicies object", 
  "id": "ALBHTTPPolicies", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "http_policy_set_path": {
      "description": "path of the virtual service HTTP policy collection. It is a reference to an object of type HTTPPolicySet.", 
      "required": true, 
      "title": "Http policy set path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_HTTPPOLICYSET_RELATIONSHIP", 
          "rightType": [
            "ALBHTTPPolicySet"
          ]
        }
      ]
    }, 
    "index": {
      "description": "Index of the virtual service HTTP policy collection.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }
  }, 
  "title": "HTTPPolicies", 
  "type": "object"
}

ALBHTTPPolicySet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPPolicySet object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBHTTPPolicySet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of cloud configuration for Pool. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "http_request_policy": {
      "$ref": "ALBHTTPRequestPolicy, 
      "description": "HTTP request policy for the virtual service.", 
      "required": false, 
      "title": "Http request policy"
    }, 
    "http_response_policy": {
      "$ref": "ALBHTTPResponsePolicy, 
      "description": "HTTP response policy for the virtual service.", 
      "required": false, 
      "title": "Http response policy"
    }, 
    "http_security_policy": {
      "$ref": "ALBHTTPSecurityPolicy, 
      "description": "HTTP security policy for the virtual service.", 
      "required": false, 
      "title": "Http security policy"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_internal_policy": {
      "default": false, 
      "description": "Placeholder for description of property is_internal_policy of obj type HTTPPolicySet field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is internal policy", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "HTTPPolicySet", 
  "type": "object"
}

ALBHTTPPolicySetApiResponse (type)

{
  "additionalProperties": false, 
  "description": "HTTPPolicySetApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBHTTPPolicySetApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of HTTPPolicySet", 
      "items": {
        "$ref": "ALBHTTPPolicySet
      }, 
      "required": false, 
      "title": "Array of HTTPPolicySet", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "HTTPPolicySetApiResponse", 
  "type": "object"
}

ALBHTTPPolicyVar (type)

{
  "description": "Valid ENUM values for ALBHTTPPolicyVar", 
  "enum": [
    "HTTP_POLICY_VAR_CLIENT_IP", 
    "HTTP_POLICY_VAR_VS_PORT", 
    "HTTP_POLICY_VAR_VS_IP", 
    "HTTP_POLICY_VAR_HTTP_HDR", 
    "HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT", 
    "HTTP_POLICY_VAR_SSL_CLIENT_SERIAL", 
    "HTTP_POLICY_VAR_SSL_CLIENT_ISSUER", 
    "HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT", 
    "HTTP_POLICY_VAR_SSL_CLIENT_RAW", 
    "HTTP_POLICY_VAR_SSL_PROTOCOL", 
    "HTTP_POLICY_VAR_SSL_SERVER_NAME", 
    "HTTP_POLICY_VAR_USER_NAME", 
    "HTTP_POLICY_VAR_SSL_CIPHER", 
    "HTTP_POLICY_VAR_REQUEST_ID", 
    "HTTP_POLICY_VAR_SSL_CLIENT_VERSION", 
    "HTTP_POLICY_VAR_SSL_CLIENT_SIGALG", 
    "HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDBEFORE", 
    "HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDAFTER"
  ], 
  "id": "ALBHTTPPolicyVar", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPPolicyVar type", 
  "type": "string"
}

ALBHTTPProtocol (type)

{
  "description": "Valid ENUM values for ALBHTTPProtocol", 
  "enum": [
    "HTTP", 
    "HTTPS"
  ], 
  "id": "ALBHTTPProtocol", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPProtocol type", 
  "type": "string"
}

ALBHTTPRedirectAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPRedirectAction object", 
  "id": "ALBHTTPRedirectAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host": {
      "$ref": "ALBURIParam, 
      "description": "Host config.", 
      "required": false, 
      "title": "Host"
    }, 
    "keep_query": {
      "default": true, 
      "description": "Keep or drop the query of the incoming request URI in the redirected URI. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Keep query", 
      "type": "boolean"
    }, 
    "path": {
      "$ref": "ALBURIParam, 
      "description": "Path config.", 
      "required": false, 
      "title": "Path"
    }, 
    "port": {
      "description": "Port to which redirect the request. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "ALBHTTPProtocol, 
      "description": "Protocol type. Enum options - HTTP, HTTPS.", 
      "required": true, 
      "title": "Protocol"
    }, 
    "status_code": {
      "$ref": "ALBHTTPRedirectStatusCode, 
      "default": "HTTP_REDIRECT_STATUS_CODE_302", 
      "description": "HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_REDIRECT_STATUS_CODE_302.", 
      "required": false, 
      "title": "Status code"
    }
  }, 
  "title": "HTTPRedirectAction", 
  "type": "object"
}

ALBHTTPRedirectStatusCode (type)

{
  "description": "Valid ENUM values for ALBHTTPRedirectStatusCode", 
  "enum": [
    "HTTP_REDIRECT_STATUS_CODE_301", 
    "HTTP_REDIRECT_STATUS_CODE_302", 
    "HTTP_REDIRECT_STATUS_CODE_307"
  ], 
  "id": "ALBHTTPRedirectStatusCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPRedirectStatusCode type", 
  "type": "string"
}

ALBHTTPRequestPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPRequestPolicy object", 
  "id": "ALBHTTPRequestPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "rules": {
      "description": "Add rules to the HTTP request policy.", 
      "items": {
        "$ref": "ALBHTTPRequestRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "HTTPRequestPolicy", 
  "type": "object"
}

ALBHTTPRequestRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPRequestRule object", 
  "id": "ALBHTTPRequestRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "all_headers": {
      "description": "Log all HTTP headers upon rule match.", 
      "required": false, 
      "title": "All headers", 
      "type": "boolean"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": true, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "hdr_action": {
      "description": "HTTP header rewrite action.", 
      "items": {
        "$ref": "ALBHTTPHdrAction
      }, 
      "required": false, 
      "title": "Hdr action", 
      "type": "array"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "log": {
      "description": "Log HTTP request upon rule match.", 
      "required": false, 
      "title": "Log", 
      "type": "boolean"
    }, 
    "match": {
      "$ref": "ALBMatchTarget, 
      "description": "Add match criteria to the rule.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "redirect_action": {
      "$ref": "ALBHTTPRedirectAction, 
      "description": "HTTP redirect action.", 
      "required": false, 
      "title": "Redirect action"
    }, 
    "rewrite_url_action": {
      "$ref": "ALBHTTPRewriteURLAction, 
      "description": "HTTP request URL rewrite action.", 
      "required": false, 
      "title": "Rewrite url action"
    }, 
    "switching_action": {
      "$ref": "ALBHTTPSwitchingAction, 
      "description": "Content switching action.", 
      "required": false, 
      "title": "Switching action"
    }
  }, 
  "title": "HTTPRequestRule", 
  "type": "object"
}

ALBHTTPReselectRespCode (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPReselectRespCode object", 
  "id": "ALBHTTPReselectRespCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "codes": {
      "description": "HTTP response code to be matched. Allowed values are 400-599.", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Codes", 
      "type": "array"
    }, 
    "ranges": {
      "description": "HTTP response code ranges to match.", 
      "items": {
        "$ref": "ALBHTTPStatusRange
      }, 
      "required": false, 
      "title": "Ranges", 
      "type": "array"
    }, 
    "resp_code_block": {
      "description": "Block of HTTP response codes to match for server reselect. Enum options - HTTP_RSP_4XX, HTTP_RSP_5XX.", 
      "items": {
        "$ref": "ALBHttpReselectRespCodeBlock
      }, 
      "required": false, 
      "title": "Resp code block", 
      "type": "array"
    }
  }, 
  "title": "HTTPReselectRespCode", 
  "type": "object"
}

ALBHTTPResponseCodes (type)

{
  "description": "Valid ENUM values for ALBHTTPResponseCodes", 
  "enum": [
    "HTTP_RESPONSE_CODE_0", 
    "HTTP_RESPONSE_CODE_100", 
    "HTTP_RESPONSE_CODE_101", 
    "HTTP_RESPONSE_CODE_200", 
    "HTTP_RESPONSE_CODE_201", 
    "HTTP_RESPONSE_CODE_202", 
    "HTTP_RESPONSE_CODE_203", 
    "HTTP_RESPONSE_CODE_204", 
    "HTTP_RESPONSE_CODE_205", 
    "HTTP_RESPONSE_CODE_206", 
    "HTTP_RESPONSE_CODE_300", 
    "HTTP_RESPONSE_CODE_301", 
    "HTTP_RESPONSE_CODE_302", 
    "HTTP_RESPONSE_CODE_303", 
    "HTTP_RESPONSE_CODE_304", 
    "HTTP_RESPONSE_CODE_305", 
    "HTTP_RESPONSE_CODE_307", 
    "HTTP_RESPONSE_CODE_400", 
    "HTTP_RESPONSE_CODE_401", 
    "HTTP_RESPONSE_CODE_402", 
    "HTTP_RESPONSE_CODE_403", 
    "HTTP_RESPONSE_CODE_404", 
    "HTTP_RESPONSE_CODE_405", 
    "HTTP_RESPONSE_CODE_406", 
    "HTTP_RESPONSE_CODE_407", 
    "HTTP_RESPONSE_CODE_408", 
    "HTTP_RESPONSE_CODE_409", 
    "HTTP_RESPONSE_CODE_410", 
    "HTTP_RESPONSE_CODE_411", 
    "HTTP_RESPONSE_CODE_412", 
    "HTTP_RESPONSE_CODE_413", 
    "HTTP_RESPONSE_CODE_414", 
    "HTTP_RESPONSE_CODE_415", 
    "HTTP_RESPONSE_CODE_416", 
    "HTTP_RESPONSE_CODE_417", 
    "HTTP_RESPONSE_CODE_426", 
    "HTTP_RESPONSE_CODE_470", 
    "HTTP_RESPONSE_CODE_475", 
    "HTTP_RESPONSE_CODE_500", 
    "HTTP_RESPONSE_CODE_501", 
    "HTTP_RESPONSE_CODE_502", 
    "HTTP_RESPONSE_CODE_503", 
    "HTTP_RESPONSE_CODE_504", 
    "HTTP_RESPONSE_CODE_505"
  ], 
  "id": "ALBHTTPResponseCodes", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPResponseCodes type", 
  "type": "string"
}

ALBHTTPResponsePolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPResponsePolicy object", 
  "id": "ALBHTTPResponsePolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "rules": {
      "description": "Add rules to the HTTP response policy.", 
      "items": {
        "$ref": "ALBHTTPResponseRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "HTTPResponsePolicy", 
  "type": "object"
}

ALBHTTPResponseRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPResponseRule object", 
  "id": "ALBHTTPResponseRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "all_headers": {
      "description": "Log all HTTP headers upon rule match.", 
      "required": false, 
      "title": "All headers", 
      "type": "boolean"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": true, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "hdr_action": {
      "description": "HTTP header rewrite action.", 
      "items": {
        "$ref": "ALBHTTPHdrAction
      }, 
      "required": false, 
      "title": "Hdr action", 
      "type": "array"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "loc_hdr_action": {
      "$ref": "ALBHTTPRewriteLocHdrAction, 
      "description": "Location header rewrite action.", 
      "required": false, 
      "title": "Loc hdr action"
    }, 
    "log": {
      "description": "Log HTTP request upon rule match.", 
      "required": false, 
      "title": "Log", 
      "type": "boolean"
    }, 
    "match": {
      "$ref": "ALBResponseMatchTarget, 
      "description": "Add match criteria to the rule.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "HTTPResponseRule", 
  "type": "object"
}

ALBHTTPRewriteLocHdrAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPRewriteLocHdrAction object", 
  "id": "ALBHTTPRewriteLocHdrAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host": {
      "$ref": "ALBURIParam, 
      "description": "Host config.", 
      "required": false, 
      "title": "Host"
    }, 
    "keep_query": {
      "default": true, 
      "description": "Keep or drop the query from the server side redirect URI. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Keep query", 
      "type": "boolean"
    }, 
    "path": {
      "$ref": "ALBURIParam, 
      "description": "Path config.", 
      "required": false, 
      "title": "Path"
    }, 
    "port": {
      "description": "Port to use in the redirected URI. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "ALBHTTPProtocol, 
      "description": "HTTP protocol type. Enum options - HTTP, HTTPS.", 
      "required": true, 
      "title": "Protocol"
    }
  }, 
  "title": "HTTPRewriteLocHdrAction", 
  "type": "object"
}

ALBHTTPRewriteURLAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPRewriteURLAction object", 
  "id": "ALBHTTPRewriteURLAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host_hdr": {
      "$ref": "ALBURIParam, 
      "description": "Host config.", 
      "required": false, 
      "title": "Host hdr"
    }, 
    "path": {
      "$ref": "ALBURIParam, 
      "description": "Path config.", 
      "required": false, 
      "title": "Path"
    }, 
    "query": {
      "$ref": "ALBURIParamQuery, 
      "description": "Query config.", 
      "required": false, 
      "title": "Query"
    }
  }, 
  "title": "HTTPRewriteURLAction", 
  "type": "object"
}

ALBHTTPSecurityAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPSecurityAction object", 
  "id": "ALBHTTPSecurityAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBHTTPSecurityActionType, 
      "description": "Type of the security action to perform. Enum options - HTTP_SECURITY_ACTION_CLOSE_CONN, HTTP_SECURITY_ACTION_SEND_RESPONSE, HTTP_SECURITY_ACTION_ALLOW, HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS, HTTP_SECURITY_ACTION_RATE_LIMIT, HTTP_SECURITY_ACTION_REQUEST_CHECK_ICAP. Allowed in Basic(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Essentials(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Enterprise edition.", 
      "required": true, 
      "title": "Action"
    }, 
    "file": {
      "$ref": "ALBHTTPLocalFile, 
      "description": "File to be used for generating HTTP local response.", 
      "required": false, 
      "title": "File"
    }, 
    "https_port": {
      "description": "Secure SSL/TLS port to redirect the HTTP request to. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Https port", 
      "type": "integer"
    }, 
    "rate_profile": {
      "$ref": "ALBHTTPSecurityActionRateProfile, 
      "description": "Rate limiting configuration for this action. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Rate profile"
    }, 
    "status_code": {
      "$ref": "ALBHTTPLocalResponseStatusCode, 
      "description": "HTTP status code to use for local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.", 
      "required": false, 
      "title": "Status code"
    }
  }, 
  "title": "HTTPSecurityAction", 
  "type": "object"
}

ALBHTTPSecurityActionRateProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPSecurityActionRateProfile object", 
  "id": "ALBHTTPSecurityActionRateProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBRateLimiterAction, 
      "description": "The action to take when the rate limit has been reached.", 
      "required": true, 
      "title": "Action"
    }, 
    "per_client_ip": {
      "description": "Rate limiting should be done on a per client ip basis.", 
      "required": false, 
      "title": "Per client ip", 
      "type": "boolean"
    }, 
    "per_uri_path": {
      "description": "Rate limiting should be done on a per request uri path basis.", 
      "required": false, 
      "title": "Per uri path", 
      "type": "boolean"
    }, 
    "rate_limiter": {
      "$ref": "ALBRateLimiter, 
      "description": "The rate limiter used when this action is triggered.", 
      "required": true, 
      "title": "Rate limiter"
    }
  }, 
  "title": "HTTPSecurityActionRateProfile", 
  "type": "object"
}

ALBHTTPSecurityActionType (type)

{
  "description": "Valid ENUM values for ALBHTTPSecurityActionType", 
  "enum": [
    "HTTP_SECURITY_ACTION_CLOSE_CONN", 
    "HTTP_SECURITY_ACTION_SEND_RESPONSE", 
    "HTTP_SECURITY_ACTION_ALLOW", 
    "HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS", 
    "HTTP_SECURITY_ACTION_RATE_LIMIT", 
    "HTTP_SECURITY_ACTION_REQUEST_CHECK_ICAP"
  ], 
  "id": "ALBHTTPSecurityActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPSecurityActionType type", 
  "type": "string"
}

ALBHTTPSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPSecurityPolicy object", 
  "id": "ALBHTTPSecurityPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "rules": {
      "description": "Add rules to the HTTP security policy.", 
      "items": {
        "$ref": "ALBHTTPSecurityRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "HTTPSecurityPolicy", 
  "type": "object"
}

ALBHTTPSecurityRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPSecurityRule object", 
  "id": "ALBHTTPSecurityRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBHTTPSecurityAction, 
      "description": "Action to be performed upon successful matching.", 
      "required": false, 
      "title": "Action"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": true, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "log": {
      "description": "Log HTTP request upon rule match.", 
      "required": false, 
      "title": "Log", 
      "type": "boolean"
    }, 
    "match": {
      "$ref": "ALBMatchTarget, 
      "description": "Add match criteria to the rule.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "HTTPSecurityRule", 
  "type": "object"
}

ALBHTTPServerReselect (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPServerReselect object", 
  "id": "ALBHTTPServerReselect", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enabled": {
      "default": false, 
      "description": "Enable HTTP request reselect when server responds with specific response codes. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "num_retries": {
      "default": 4, 
      "description": "Number of times to retry an HTTP request when server responds with configured status codes. Default value when not specified in API or module is interpreted by ALB Controller as 4.", 
      "minimum": 0, 
      "required": false, 
      "title": "Num retries", 
      "type": "integer"
    }, 
    "retry_nonidempotent": {
      "default": false, 
      "description": "Allow retry of non-idempotent HTTP requests. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Retry nonidempotent", 
      "type": "boolean"
    }, 
    "retry_timeout": {
      "default": 0, 
      "description": "Timeout per retry attempt, for a given request. Value of 0 indicates default timeout. Allowed values are 0-3600000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 3600000, 
      "minimum": 0, 
      "required": false, 
      "title": "Retry timeout", 
      "type": "integer"
    }, 
    "svr_resp_code": {
      "$ref": "ALBHTTPReselectRespCode, 
      "description": "Server response codes which will trigger an HTTP request retry.", 
      "required": false, 
      "title": "Svr resp code"
    }
  }, 
  "title": "HTTPServerReselect", 
  "type": "object"
}

ALBHTTPStatusMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPStatusMatch object", 
  "id": "ALBHTTPStatusMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for matching the HTTP response status code(s). Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "ranges": {
      "description": "HTTP response status code range(s).", 
      "items": {
        "$ref": "ALBHTTPStatusRange
      }, 
      "required": false, 
      "title": "Ranges", 
      "type": "array"
    }, 
    "status_codes": {
      "description": "HTTP response status code(s).", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Status codes", 
      "type": "array"
    }
  }, 
  "title": "HTTPStatusMatch", 
  "type": "object"
}

ALBHTTPStatusRange (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPStatusRange object", 
  "id": "ALBHTTPStatusRange", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "begin": {
      "description": "Starting HTTP response status code.", 
      "required": true, 
      "title": "Begin", 
      "type": "integer"
    }, 
    "end": {
      "description": "Ending HTTP response status code.", 
      "required": true, 
      "title": "End", 
      "type": "integer"
    }
  }, 
  "title": "HTTPStatusRange", 
  "type": "object"
}

ALBHTTPSwitchingAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPSwitchingAction object", 
  "id": "ALBHTTPSwitchingAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBHTTPSwitchingActionType, 
      "description": "Content switching action type. Enum options - HTTP_SWITCHING_SELECT_POOL, HTTP_SWITCHING_SELECT_LOCAL, HTTP_SWITCHING_SELECT_POOLGROUP. Allowed in Essentials(Allowed values- HTTP_SWITCHING_SELECT_POOL,HTTP_SWITCHING_SELECT_LOCAL) edition, Enterprise edition.", 
      "required": true, 
      "title": "Action"
    }, 
    "file": {
      "$ref": "ALBHTTPLocalFile, 
      "description": "File from which to serve local response to the request.", 
      "required": false, 
      "title": "File"
    }, 
    "pool_group_path": {
      "description": "path of the pool group to serve the request. It is a reference to an object of type PoolGroup.", 
      "required": false, 
      "title": "Pool group path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHTTPPolicySet"
          ], 
          "relationshipType": "ALB_HTTPPOLICYSET_ALB_POOLGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroup"
          ]
        }
      ]
    }, 
    "pool_path": {
      "description": "path of the pool of servers to serve the request. It is a reference to an object of type Pool.", 
      "required": false, 
      "title": "Pool path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHTTPPolicySet"
          ], 
          "relationshipType": "ALB_HTTPPOLICYSET_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }, 
    "server": {
      "$ref": "ALBPoolServer, 
      "description": "Specific pool server to select.", 
      "required": false, 
      "title": "Server"
    }, 
    "status_code": {
      "$ref": "ALBHTTPLocalResponseStatusCode, 
      "description": "HTTP status code to use when serving local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.", 
      "required": false, 
      "title": "Status code"
    }
  }, 
  "title": "HTTPSwitchingAction", 
  "type": "object"
}

ALBHTTPSwitchingActionType (type)

{
  "description": "Valid ENUM values for ALBHTTPSwitchingActionType", 
  "enum": [
    "HTTP_SWITCHING_SELECT_POOL", 
    "HTTP_SWITCHING_SELECT_LOCAL", 
    "HTTP_SWITCHING_SELECT_POOLGROUP"
  ], 
  "id": "ALBHTTPSwitchingActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPSwitchingActionType type", 
  "type": "string"
}

ALBHTTPVersion (type)

{
  "description": "Valid ENUM values for ALBHTTPVersion", 
  "enum": [
    "ZERO_NINE", 
    "ONE_ZERO", 
    "ONE_ONE", 
    "TWO_ZERO"
  ], 
  "id": "ALBHTTPVersion", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HTTPVersion type", 
  "type": "string"
}

ALBHTTPVersionMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HTTPVersionMatch object", 
  "id": "ALBHTTPVersionMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for HTTP version matching the version used in the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "versions": {
      "description": "HTTP protocol version. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Minimum of 1 items required. Maximum of 8 items allowed. Allowed in Basic(Allowed values- ONE_ZERO,ONE_ONE) edition, Essentials(Allowed values- ONE_ZERO,ONE_ONE) edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBHTTPVersion
      }, 
      "required": true, 
      "title": "Versions", 
      "type": "array"
    }
  }, 
  "title": "HTTPVersionMatch", 
  "type": "object"
}

ALBHardwareSecurityModule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HardwareSecurityModule object", 
  "id": "ALBHardwareSecurityModule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cloudhsm": {
      "$ref": "ALBHSMAwsCloudHsm, 
      "description": "AWS CloudHSM specific configuration.", 
      "required": false, 
      "title": "Cloudhsm"
    }, 
    "nethsm": {
      "description": "Thales netHSM specific configuration.", 
      "items": {
        "$ref": "ALBHSMThalesNetHsm
      }, 
      "required": false, 
      "title": "Nethsm", 
      "type": "array"
    }, 
    "rfs": {
      "$ref": "ALBHSMThalesRFS, 
      "description": "Thales Remote File Server (RFS), used for the netHSMs, configuration.", 
      "required": false, 
      "title": "Rfs"
    }, 
    "sluna": {
      "$ref": "ALBHSMSafenetLuna, 
      "description": "Safenet/Gemalto Luna/Gem specific configuration.", 
      "required": false, 
      "title": "Sluna"
    }, 
    "type": {
      "$ref": "ALBHSMType, 
      "description": "HSM type to use. Enum options - HSM_TYPE_THALES_NETHSM, HSM_TYPE_SAFENET_LUNA, HSM_TYPE_AWS_CLOUDHSM.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "HardwareSecurityModule", 
  "type": "object"
}

ALBHardwareSecurityModuleGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HardwareSecurityModuleGroup object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBHardwareSecurityModuleGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "hsm": {
      "$ref": "ALBHardwareSecurityModule, 
      "description": "Hardware Security Module configuration.", 
      "required": true, 
      "title": "Hsm"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "HardwareSecurityModuleGroup", 
  "type": "object"
}

ALBHardwareSecurityModuleGroupApiResponse (type)

{
  "additionalProperties": false, 
  "description": "HardwareSecurityModuleGroupApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBHardwareSecurityModuleGroupApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of HardwareSecurityModuleGroup", 
      "items": {
        "$ref": "ALBHardwareSecurityModuleGroup
      }, 
      "required": false, 
      "title": "Array of HardwareSecurityModuleGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "HardwareSecurityModuleGroupApiResponse", 
  "type": "object"
}

ALBHdrMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HdrMatch object", 
  "id": "ALBHdrMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "hdr": {
      "description": "Name of the HTTP header whose value is to be matched.", 
      "required": true, 
      "title": "Hdr", 
      "type": "string"
    }, 
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBHdrMatchOperation, 
      "description": "Criterion to use for matching headers in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "value": {
      "description": "String values to match in the HTTP header.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Value", 
      "type": "array"
    }
  }, 
  "title": "HdrMatch", 
  "type": "object"
}

ALBHdrMatchOperation (type)

{
  "description": "Valid ENUM values for ALBHdrMatchOperation", 
  "enum": [
    "HDR_EXISTS", 
    "HDR_DOES_NOT_EXIST", 
    "HDR_BEGINS_WITH", 
    "HDR_DOES_NOT_BEGIN_WITH", 
    "HDR_CONTAINS", 
    "HDR_DOES_NOT_CONTAIN", 
    "HDR_ENDS_WITH", 
    "HDR_DOES_NOT_END_WITH", 
    "HDR_EQUALS", 
    "HDR_DOES_NOT_EQUAL"
  ], 
  "id": "ALBHdrMatchOperation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HdrMatchOperation type", 
  "type": "string"
}

ALBHdrPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HdrPersistenceProfile object", 
  "id": "ALBHdrPersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "prst_hdr_name": {
      "description": "Header name for custom header persistence.", 
      "required": false, 
      "title": "Prst hdr name", 
      "type": "string"
    }
  }, 
  "title": "HdrPersistenceProfile", 
  "type": "object"
}

ALBHealthMonitor (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitor object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBHealthMonitor", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "allow_duplicate_monitors": {
      "description": "By default, multiple instances of the same healthmonitor to the same server are suppressed intelligently. In rare cases, the monitor may have specific constructs that go beyond the server keys (ip, port, etc.) during which such suppression is not desired. Use this knob to allow duplicates. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition.", 
      "required": false, 
      "title": "Allow duplicate monitors", 
      "type": "boolean"
    }, 
    "authentication": {
      "$ref": "ALBHealthMonitorAuthInfo, 
      "description": "Authentication information for username/password. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Authentication"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "disable_quickstart": {
      "description": "During addition of a server or healthmonitors or during bootup, Avi performs sequential health checks rather than waiting for send-interval to kick in, to mark the server up as soon as possible. This knob may be used to turn this feature off. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.", 
      "required": false, 
      "title": "Disable quickstart", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "dns_monitor": {
      "$ref": "ALBHealthMonitorDNS, 
      "description": "Placeholder for description of property dns_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "Dns monitor"
    }, 
    "external_monitor": {
      "$ref": "ALBHealthMonitorExternal, 
      "description": "Placeholder for description of property external_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "External monitor"
    }, 
    "failed_checks": {
      "default": 2, 
      "description": "Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 50, 
      "minimum": 1, 
      "required": false, 
      "title": "Failed checks", 
      "type": "integer"
    }, 
    "http_monitor": {
      "$ref": "ALBHealthMonitorHttp, 
      "description": "Placeholder for description of property http_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "Http monitor"
    }, 
    "https_monitor": {
      "$ref": "ALBHealthMonitorHttp, 
      "description": "Placeholder for description of property https_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "Https monitor"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "imap_monitor": {
      "$ref": "ALBHealthMonitorImap, 
      "description": "Health monitor for IMAP.", 
      "required": false, 
      "title": "Imap monitor"
    }, 
    "imaps_monitor": {
      "$ref": "ALBHealthMonitorImap, 
      "description": "Health monitor for IMAPS.", 
      "required": false, 
      "title": "Imaps monitor"
    }, 
    "is_federated": {
      "default": false, 
      "description": "This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is federated", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "monitor_port": {
      "description": "Use this port instead of the port defined for the server in the Pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the Pool. Allowed values are 1-65535. Special values are 0 - 'Use server port'.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port", 
      "type": "integer"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "pop3_monitor": {
      "$ref": "ALBHealthMonitorPop3, 
      "description": "Health monitor for POP3.", 
      "required": false, 
      "title": "Pop3 monitor"
    }, 
    "pop3s_monitor": {
      "$ref": "ALBHealthMonitorPop3, 
      "description": "Health monitor for POP3S.", 
      "required": false, 
      "title": "Pop3s monitor"
    }, 
    "radius_monitor": {
      "$ref": "ALBHealthMonitorRadius, 
      "description": "Health monitor for Radius. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Radius monitor"
    }, 
    "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"
    }, 
    "receive_timeout": {
      "default": 4, 
      "description": "A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value. Allowed values are 1-2400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 4.", 
      "maximum": 2400, 
      "minimum": 1, 
      "required": false, 
      "title": "Receive timeout", 
      "type": "integer"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "send_interval": {
      "default": 10, 
      "description": "Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "maximum": 3600, 
      "minimum": 1, 
      "required": false, 
      "title": "Send interval", 
      "type": "integer"
    }, 
    "sip_monitor": {
      "$ref": "ALBHealthMonitorSIP, 
      "description": "Health monitor for SIP. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Sip monitor"
    }, 
    "smtp_monitor": {
      "$ref": "ALBHealthMonitorSmtp, 
      "description": "Health monitor for SMTP.", 
      "required": false, 
      "title": "Smtp monitor"
    }, 
    "smtps_monitor": {
      "$ref": "ALBHealthMonitorSmtp, 
      "description": "Health monitor for SMTPS.", 
      "required": false, 
      "title": "Smtps monitor"
    }, 
    "successful_checks": {
      "default": 2, 
      "description": "Number of continuous successful health checks before server is marked up. Allowed values are 1-50. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 50, 
      "minimum": 1, 
      "required": false, 
      "title": "Successful checks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_monitor": {
      "$ref": "ALBHealthMonitorTcp, 
      "description": "Placeholder for description of property tcp_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "Tcp monitor"
    }, 
    "type": {
      "$ref": "ALBHealthMonitorType, 
      "description": "Type of the health monitor. Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS, HEALTH_MONITOR_SMTP, HEALTH_MONITOR_SMTPS, HEALTH_MONITOR_POP3, HEALTH_MONITOR_POP3S, HEALTH_MONITOR_IMAP, HEALTH_MONITOR_IMAPS. Allowed in Basic(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP,HEALTH_MONITOR_HTTP,HEALTH_MONITOR_HTTPS) edition, Essentials(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP) edition, Enterprise edition.", 
      "required": true, 
      "title": "Type"
    }, 
    "udp_monitor": {
      "$ref": "ALBHealthMonitorUdp, 
      "description": "Placeholder for description of property udp_monitor of obj type HealthMonitor field type str  type ref.", 
      "required": false, 
      "title": "Udp monitor"
    }, 
    "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": "HealthMonitor", 
  "type": "object"
}

ALBHealthMonitorApiResponse (type)

{
  "additionalProperties": false, 
  "description": "HealthMonitorApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBHealthMonitorApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of HealthMonitor", 
      "items": {
        "$ref": "ALBHealthMonitor
      }, 
      "required": false, 
      "title": "Array of HealthMonitor", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorApiResponse", 
  "type": "object"
}

ALBHealthMonitorAuthInfo (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorAuthInfo object", 
  "id": "ALBHealthMonitorAuthInfo", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "password": {
      "description": "Password for server authentication.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "username": {
      "description": "Username for server authentication.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "secure_string"
    }
  }, 
  "title": "HealthMonitorAuthInfo", 
  "type": "object"
}

ALBHealthMonitorAuthType (type)

{
  "description": "Valid ENUM values for ALBHealthMonitorAuthType", 
  "enum": [
    "AUTH_BASIC", 
    "AUTH_NTLM"
  ], 
  "id": "ALBHealthMonitorAuthType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HealthMonitorAuthType type", 
  "type": "string"
}

ALBHealthMonitorDNS (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorDNS object", 
  "id": "ALBHealthMonitorDNS", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "qtype": {
      "$ref": "ALBHealthMonitorDNSQueryType, 
      "default": "DNS_QUERY_TYPE", 
      "description": "Query_Type  Response has atleast one answer of which      the resource record type matches the query type   Any_Type  Response should contain atleast one answer  AnyThing  An empty answer is enough. Enum options - DNS_QUERY_TYPE, DNS_ANY_TYPE, DNS_ANY_THING. Default value when not specified in API or module is interpreted by ALB Controller as DNS_QUERY_TYPE.", 
      "required": false, 
      "title": "Qtype"
    }, 
    "query_name": {
      "description": "The DNS monitor will query the DNS server for the fully qualified name in this field.", 
      "required": true, 
      "title": "Query name", 
      "type": "string"
    }, 
    "rcode": {
      "$ref": "ALBHealthMonitorDNSRcode, 
      "default": "RCODE_NO_ERROR", 
      "description": "When No Error is selected, a DNS query will be marked failed is any error code is returned by the server. With Any selected, the monitor ignores error code in the responses. Enum options - RCODE_NO_ERROR, RCODE_ANYTHING. Default value when not specified in API or module is interpreted by ALB Controller as RCODE_NO_ERROR.", 
      "required": false, 
      "title": "Rcode"
    }, 
    "record_type": {
      "$ref": "ALBDnsRecordType, 
      "default": "DNS_RECORD_A", 
      "description": "Resource record type used in the healthmonitor DNS query, only A or AAAA type supported. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Default value when not specified in API or module is interpreted by ALB Controller as DNS_RECORD_A.", 
      "required": false, 
      "title": "Record type"
    }, 
    "response_string": {
      "description": "The resource record of the queried DNS server's response for the Request Name must include the IP address defined in this field.", 
      "required": false, 
      "title": "Response string", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorDNS", 
  "type": "object"
}

ALBHealthMonitorDNSQueryType (type)

{
  "description": "Valid ENUM values for ALBHealthMonitorDNSQueryType", 
  "enum": [
    "DNS_QUERY_TYPE", 
    "DNS_ANY_TYPE", 
    "DNS_ANY_THING"
  ], 
  "id": "ALBHealthMonitorDNSQueryType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HealthMonitorDNSQueryType type", 
  "type": "string"
}

ALBHealthMonitorDNSRcode (type)

{
  "description": "Valid ENUM values for ALBHealthMonitorDNSRcode", 
  "enum": [
    "RCODE_NO_ERROR", 
    "RCODE_ANYTHING"
  ], 
  "id": "ALBHealthMonitorDNSRcode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HealthMonitorDNSRcode type", 
  "type": "string"
}

ALBHealthMonitorExternal (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorExternal object", 
  "id": "ALBHealthMonitorExternal", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "command_code": {
      "description": "Command script provided inline.", 
      "required": true, 
      "title": "Command code", 
      "type": "string"
    }, 
    "command_parameters": {
      "description": "Optional arguments to feed into the script.", 
      "required": false, 
      "title": "Command parameters", 
      "type": "string"
    }, 
    "command_path": {
      "description": "Path of external health monitor script.", 
      "required": false, 
      "title": "Command path", 
      "type": "string"
    }, 
    "command_variables": {
      "description": "Environment variables to be fed into the script.", 
      "required": false, 
      "title": "Command variables", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorExternal", 
  "type": "object"
}

ALBHealthMonitorHttp (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorHttp object", 
  "id": "ALBHealthMonitorHttp", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "auth_type": {
      "$ref": "ALBHealthMonitorAuthType, 
      "description": "Type of the authentication method. Enum options - AUTH_BASIC, AUTH_NTLM. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Auth type"
    }, 
    "exact_http_request": {
      "default": false, 
      "description": "Use the exact http_request string as specified by user, without any automatic insert of headers like Host header. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Exact http request", 
      "type": "boolean"
    }, 
    "http_request": {
      "default": "GET / HTTP/1.0", 
      "description": "Send an HTTP request to the server. The default GET / HTTP/1.0 may be extended with additional headers or information. For instance, GET /index.htm HTTP/1.1 Host  www.site.com Connection  Close. Default value when not specified in API or module is interpreted by ALB Controller as GET / HTTP/1.0.", 
      "required": false, 
      "title": "Http request", 
      "type": "string"
    }, 
    "http_request_body": {
      "description": "HTTP request body.", 
      "required": false, 
      "title": "Http request body", 
      "type": "string"
    }, 
    "http_response": {
      "description": "Match for a keyword in the first 2Kb of the server header and body response.", 
      "required": false, 
      "title": "Http response", 
      "type": "string"
    }, 
    "http_response_code": {
      "description": "List of HTTP response codes to match as successful. Default is 2xx. Enum options - HTTP_ANY, HTTP_1XX, HTTP_2XX, HTTP_3XX, HTTP_4XX, HTTP_5XX. Minimum of 1 items required.", 
      "items": {
        "$ref": "ALBHttpResponseCode
      }, 
      "required": true, 
      "title": "Http response code", 
      "type": "array"
    }, 
    "maintenance_code": {
      "description": "Match or look for this HTTP response code indicating server maintenance. A successful match results in the server being marked down. Allowed values are 101-599. Maximum of 4 items allowed.", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Maintenance code", 
      "type": "array"
    }, 
    "maintenance_response": {
      "description": "Match or look for this keyword in the first 2KB of server header and body response indicating server maintenance. A successful match results in the server being marked down.", 
      "required": false, 
      "title": "Maintenance response", 
      "type": "string"
    }, 
    "response_size": {
      "description": "Expected http/https response page size. Allowed values are 2048-16384.", 
      "maximum": 16384, 
      "minimum": 2048, 
      "required": false, 
      "title": "Response size", 
      "type": "integer"
    }, 
    "ssl_attributes": {
      "$ref": "ALBHealthMonitorSSLAttributes, 
      "description": "SSL attributes for HTTPS health monitor.", 
      "required": false, 
      "title": "Ssl attributes"
    }
  }, 
  "title": "HealthMonitorHttp", 
  "type": "object"
}

ALBHealthMonitorImap (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorImap object", 
  "id": "ALBHealthMonitorImap", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "folder": {
      "description": "Folder to access.", 
      "required": false, 
      "title": "Folder", 
      "type": "string"
    }, 
    "ssl_attributes": {
      "$ref": "ALBHealthMonitorSSLAttributes, 
      "description": "SSL attributes for IMAPS monitor.", 
      "required": false, 
      "title": "Ssl attributes"
    }
  }, 
  "title": "HealthMonitorImap", 
  "type": "object"
}

ALBHealthMonitorPop3 (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorPop3 object", 
  "id": "ALBHealthMonitorPop3", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ssl_attributes": {
      "$ref": "ALBHealthMonitorSSLAttributes, 
      "description": "SSL attributes for POP3S monitor.", 
      "required": false, 
      "title": "Ssl attributes"
    }
  }, 
  "title": "HealthMonitorPop3", 
  "type": "object"
}

ALBHealthMonitorRadius (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorRadius object", 
  "id": "ALBHealthMonitorRadius", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "password": {
      "description": "Radius monitor will query Radius server with this password.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "shared_secret": {
      "description": "Radius monitor will query Radius server with this shared secret.", 
      "required": true, 
      "sensitive": true, 
      "title": "Shared secret", 
      "type": "secure_string"
    }, 
    "username": {
      "description": "Radius monitor will query Radius server with this username.", 
      "required": true, 
      "title": "Username", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorRadius", 
  "type": "object"
}

ALBHealthMonitorSIP (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorSIP object", 
  "id": "ALBHealthMonitorSIP", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "sip_monitor_transport": {
      "$ref": "ALBSipMonTransport, 
      "default": "SIP_UDP_PROTO", 
      "description": "Specify the transport protocol TCP or UDP, to be used for SIP health monitor. The default transport is UDP. Enum options - SIP_UDP_PROTO, SIP_TCP_PROTO. Default value when not specified in API or module is interpreted by ALB Controller as SIP_UDP_PROTO.", 
      "required": false, 
      "title": "Sip monitor transport"
    }, 
    "sip_request_code": {
      "$ref": "ALBSipRequestCode, 
      "default": "SIP_OPTIONS", 
      "description": "Specify the SIP request to be sent to the server. By default, SIP OPTIONS request will be sent. Enum options - SIP_OPTIONS. Default value when not specified in API or module is interpreted by ALB Controller as SIP_OPTIONS.", 
      "required": false, 
      "title": "Sip request code"
    }, 
    "sip_response": {
      "default": "SIP/2.0", 
      "description": "Match for a keyword in the first 2KB of the server header and body response. By default, it matches for SIP/2.0. Default value when not specified in API or module is interpreted by ALB Controller as SIP/2.0.", 
      "required": false, 
      "title": "Sip response", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorSIP", 
  "type": "object"
}

ALBHealthMonitorSSLAttributes (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorSSLAttributes object", 
  "id": "ALBHealthMonitorSSLAttributes", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "pki_profile_path": {
      "description": "PKI profile used to validate the SSL certificate presented by a server. It is a reference to an object of type PKIProfile.", 
      "required": false, 
      "title": "Pki profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHealthMonitor"
          ], 
          "relationshipType": "ALB_HEALTHMONITOR_ALB_PKIPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBPKIProfile"
          ]
        }
      ]
    }, 
    "server_name": {
      "description": "Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections indicating SNI is enabled.", 
      "required": false, 
      "title": "Server name", 
      "type": "string"
    }, 
    "ssl_key_and_certificate_path": {
      "description": "Service engines will present this SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.", 
      "required": false, 
      "title": "Ssl key and certificate path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHealthMonitor"
          ], 
          "relationshipType": "ALB_HEALTHMONITOR_ALB_SSLKEYANDCERTIFICATE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLKeyAndCertificate"
          ]
        }
      ]
    }, 
    "ssl_profile_path": {
      "description": "SSL profile defines ciphers and SSL versions to be used for healthmonitor traffic to the back-end servers. It is a reference to an object of type SSLProfile.", 
      "required": true, 
      "title": "Ssl profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHealthMonitor"
          ], 
          "relationshipType": "ALB_HEALTHMONITOR_ALB_SSLPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLProfile"
          ]
        }
      ]
    }
  }, 
  "title": "HealthMonitorSSLAttributes", 
  "type": "object"
}

ALBHealthMonitorSmtp (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorSmtp object", 
  "id": "ALBHealthMonitorSmtp", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "domainname": {
      "description": "Sender domain name.", 
      "required": false, 
      "title": "Domainname", 
      "type": "string"
    }, 
    "mail_data": {
      "description": "Mail data.", 
      "required": false, 
      "title": "Mail data", 
      "type": "string"
    }, 
    "recipients_ids": {
      "description": "Mail recipients.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Recipients ids", 
      "type": "array"
    }, 
    "sender_id": {
      "description": "Mail sender.", 
      "required": false, 
      "title": "Sender id", 
      "type": "string"
    }, 
    "ssl_attributes": {
      "$ref": "ALBHealthMonitorSSLAttributes, 
      "description": "SSL attributes for SMTPS monitor.", 
      "required": false, 
      "title": "Ssl attributes"
    }
  }, 
  "title": "HealthMonitorSmtp", 
  "type": "object"
}

ALBHealthMonitorTcp (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorTcp object", 
  "id": "ALBHealthMonitorTcp", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "maintenance_response": {
      "description": "Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down.", 
      "required": false, 
      "title": "Maintenance response", 
      "type": "string"
    }, 
    "tcp_half_open": {
      "default": false, 
      "description": "Configure TCP health monitor to use half-open TCP connections to monitor the health of backend servers thereby avoiding consumption of a full fledged server side connection and the overhead and logs associated with it. This method is light-weight as it makes use of listener in server's kernel layer to measure the health and a child socket or user thread is not created on the server side. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Tcp half open", 
      "type": "boolean"
    }, 
    "tcp_request": {
      "description": "Request data to send after completing the TCP handshake.", 
      "required": false, 
      "title": "Tcp request", 
      "type": "string"
    }, 
    "tcp_response": {
      "description": "Match for the desired keyword in the first 2Kb of the server's TCP response. If this field is left blank, no server response is required.", 
      "required": false, 
      "title": "Tcp response", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorTcp", 
  "type": "object"
}

ALBHealthMonitorType (type)

{
  "description": "Valid ENUM values for ALBHealthMonitorType", 
  "enum": [
    "HEALTH_MONITOR_PING", 
    "HEALTH_MONITOR_TCP", 
    "HEALTH_MONITOR_HTTP", 
    "HEALTH_MONITOR_HTTPS", 
    "HEALTH_MONITOR_EXTERNAL", 
    "HEALTH_MONITOR_UDP", 
    "HEALTH_MONITOR_DNS", 
    "HEALTH_MONITOR_GSLB", 
    "HEALTH_MONITOR_SIP", 
    "HEALTH_MONITOR_RADIUS", 
    "HEALTH_MONITOR_SMTP", 
    "HEALTH_MONITOR_SMTPS", 
    "HEALTH_MONITOR_POP3", 
    "HEALTH_MONITOR_POP3S", 
    "HEALTH_MONITOR_IMAP", 
    "HEALTH_MONITOR_IMAPS"
  ], 
  "id": "ALBHealthMonitorType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HealthMonitorType type", 
  "type": "string"
}

ALBHealthMonitorUdp (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HealthMonitorUdp object", 
  "id": "ALBHealthMonitorUdp", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "maintenance_response": {
      "description": "Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down.", 
      "required": false, 
      "title": "Maintenance response", 
      "type": "string"
    }, 
    "udp_request": {
      "description": "Send UDP request.", 
      "required": false, 
      "title": "Udp request", 
      "type": "string"
    }, 
    "udp_response": {
      "description": "Match for keyword in the UDP response.", 
      "required": false, 
      "title": "Udp response", 
      "type": "string"
    }
  }, 
  "title": "HealthMonitorUdp", 
  "type": "object"
}

ALBHostHdrMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HostHdrMatch object", 
  "id": "ALBHostHdrMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBHdrMatchOperation, 
      "description": "Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "value": {
      "description": "String value(s) in the host header.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Value", 
      "type": "array"
    }
  }, 
  "title": "HostHdrMatch", 
  "type": "object"
}

ALBHttpCacheConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HttpCacheConfig object", 
  "id": "ALBHttpCacheConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "age_header": {
      "default": true, 
      "description": "Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Age header", 
      "type": "boolean"
    }, 
    "aggressive": {
      "default": false, 
      "description": "Enable/disable caching objects without Cache-Control headers. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Aggressive", 
      "type": "boolean"
    }, 
    "date_header": {
      "default": true, 
      "description": "If a Date header was not added by the server, add a Date header to the object served from cache. This indicates to the client when the object was originally sent by the server to the cache. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Date header", 
      "type": "boolean"
    }, 
    "default_expire": {
      "default": 600, 
      "description": "Default expiration time of cache objects received from the server without a Cache-Control expiration header. This value may be overwritten by the Heuristic Expire setting. Default value when not specified in API or module is interpreted by ALB Controller as 600.", 
      "required": false, 
      "title": "Default expire", 
      "type": "integer"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value). Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "heuristic_expire": {
      "default": false, 
      "description": "If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration. If unable to solicit an Last-Modified header, then the system will fall back to the Cache Expire Time value. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Heuristic expire", 
      "type": "boolean"
    }, 
    "ignore_request_cache_control": {
      "default": false, 
      "description": "Ignore client's cache control headers when fetching or storing from and to the cache. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Ignore request cache control", 
      "type": "boolean"
    }, 
    "max_cache_size": {
      "default": 0, 
      "description": "Max size, in bytes, of the cache. The default, zero, indicates auto configuration. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Max cache size", 
      "type": "integer"
    }, 
    "max_object_size": {
      "default": 4194304, 
      "description": "Maximum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 4194304.", 
      "required": false, 
      "title": "Max object size", 
      "type": "integer"
    }, 
    "mime_types_block_group_paths": {
      "description": "Blocklist string group of non-cacheable mime types. It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Mime types block group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "mime_types_block_lists": {
      "description": "Blocklist of non-cacheable mime types.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Mime types block lists", 
      "type": "array"
    }, 
    "mime_types_group_paths": {
      "description": "Allowlist string group of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR). It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Mime types group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "mime_types_list": {
      "description": "Allowlist of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to (STAR)/(STAR).", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Mime types list", 
      "type": "array"
    }, 
    "min_object_size": {
      "default": 100, 
      "description": "Minimum size of an object to store in the cache. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "required": false, 
      "title": "Min object size", 
      "type": "integer"
    }, 
    "query_cacheable": {
      "default": false, 
      "description": "Allow caching of objects whose URI included a query argument. When disabled, these objects are not cached. When enabled, the request must match the URI query to be considered a hit. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Query cacheable", 
      "type": "boolean"
    }, 
    "uri_non_cacheable": {
      "$ref": "ALBPathMatch, 
      "description": "Non-cacheable URI configuration with match criteria.", 
      "required": false, 
      "title": "Uri non cacheable"
    }, 
    "xcache_header": {
      "default": true, 
      "description": "Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Xcache header", 
      "type": "boolean"
    }
  }, 
  "title": "HttpCacheConfig", 
  "type": "object"
}

ALBHttpCookiePersistenceKey (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HttpCookiePersistenceKey object", 
  "id": "ALBHttpCookiePersistenceKey", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "aes_key": {
      "description": "aes_key of HttpCookiePersistenceKey.", 
      "required": false, 
      "title": "Aes key", 
      "type": "string"
    }, 
    "hmac_key": {
      "description": "hmac_key of HttpCookiePersistenceKey.", 
      "required": false, 
      "title": "Hmac key", 
      "type": "string"
    }, 
    "name": {
      "description": "name to use for cookie encryption.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "HttpCookiePersistenceKey", 
  "type": "object"
}

ALBHttpCookiePersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer HttpCookiePersistenceProfile object", 
  "id": "ALBHttpCookiePersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "always_send_cookie": {
      "default": false, 
      "description": "If no persistence cookie was received from the client, always send it. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Always send cookie", 
      "type": "boolean"
    }, 
    "cookie_name": {
      "description": "HTTP cookie name for cookie persistence.", 
      "required": false, 
      "title": "Cookie name", 
      "type": "string"
    }, 
    "encryption_key": {
      "description": "Key name to use for cookie encryption.", 
      "required": false, 
      "title": "Encryption key", 
      "type": "string"
    }, 
    "key": {
      "description": "Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str  type array.", 
      "items": {
        "$ref": "ALBHttpCookiePersistenceKey
      }, 
      "required": false, 
      "title": "Key", 
      "type": "array"
    }, 
    "timeout": {
      "description": "The maximum lifetime of any session cookie. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- 'No Timeout'. Unit is MIN.", 
      "maximum": 14400, 
      "minimum": 0, 
      "required": false, 
      "title": "Timeout", 
      "type": "integer"
    }
  }, 
  "title": "HttpCookiePersistenceProfile", 
  "type": "object"
}

ALBHttpReselectRespCodeBlock (type)

{
  "description": "Valid ENUM values for ALBHttpReselectRespCodeBlock", 
  "enum": [
    "HTTP_RSP_4XX", 
    "HTTP_RSP_5XX"
  ], 
  "id": "ALBHttpReselectRespCodeBlock", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HttpReselectRespCodeBlock type", 
  "type": "string"
}

ALBHttpResponseCode (type)

{
  "description": "Valid ENUM values for ALBHttpResponseCode", 
  "enum": [
    "HTTP_ANY", 
    "HTTP_1XX", 
    "HTTP_2XX", 
    "HTTP_3XX", 
    "HTTP_4XX", 
    "HTTP_5XX"
  ], 
  "id": "ALBHttpResponseCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "HttpResponseCode type", 
  "type": "string"
}

ALBIPNetworkSubnet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IPNetworkSubnet object", 
  "id": "ALBIPNetworkSubnet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "network_name": {
      "description": "Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network.", 
      "required": false, 
      "title": "Network name", 
      "type": "string"
    }, 
    "subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.", 
      "required": false, 
      "title": "Subnet"
    }, 
    "subnet6": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Subnet for VirtualService IPv6 allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Subnet6"
    }, 
    "subnet6_uuid": {
      "description": "Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Subnet6 uuid", 
      "type": "string"
    }, 
    "subnet_uuid": {
      "description": "Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.", 
      "required": false, 
      "title": "Subnet uuid", 
      "type": "string"
    }
  }, 
  "title": "IPNetworkSubnet", 
  "type": "object"
}

ALBIPPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IPPersistenceProfile object", 
  "id": "ALBIPPersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip_mask": {
      "description": "Mask to be applied on client IP. This may be used to persist clients from a subnet to the same server. When set to 0, all requests are sent to the same server. Allowed values are 0-128. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "maximum": 128, 
      "minimum": 0, 
      "required": false, 
      "title": "Ip mask", 
      "type": "integer"
    }, 
    "ip_persistent_timeout": {
      "default": 5, 
      "description": "The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 5.", 
      "maximum": 720, 
      "minimum": 1, 
      "required": false, 
      "title": "Ip persistent timeout", 
      "type": "integer"
    }
  }, 
  "title": "IPPersistenceProfile", 
  "type": "object"
}

ALBIdleConnectionType (type)

{
  "description": "Valid ENUM values for ALBIdleConnectionType", 
  "enum": [
    "KEEP_ALIVE", 
    "CLOSE_IDLE"
  ], 
  "id": "ALBIdleConnectionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "IdleConnectionType type", 
  "type": "string"
}

ALBIpAddr (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddr object", 
  "id": "ALBIpAddr", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "addr": {
      "description": "IP address.", 
      "required": true, 
      "title": "Addr", 
      "type": "string"
    }, 
    "type": {
      "$ref": "ALBIpAddrType, 
      "description": "Enum options - V4, DNS, V6.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "IpAddr", 
  "type": "object"
}

ALBIpAddrGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddrGroup object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBIpAddrGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "addrs": {
      "description": "Configure IP address(es).", 
      "items": {
        "$ref": "ALBIpAddr
      }, 
      "required": false, 
      "title": "Addrs", 
      "type": "array"
    }, 
    "apic_epg_name": {
      "description": "Populate IP addresses from members of this Cisco APIC EPG.", 
      "required": false, 
      "title": "Apic epg name", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "country_codes": {
      "description": "Populate the IP address ranges from the geo database for this country.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Country codes", 
      "type": "array"
    }, 
    "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"
    }, 
    "ip_ports": {
      "description": "Configure (IP address, port) tuple(s).", 
      "items": {
        "$ref": "ALBIpAddrPort
      }, 
      "required": false, 
      "title": "Ip ports", 
      "type": "array"
    }, 
    "marathon_app_name": {
      "description": "Populate IP addresses from tasks of this Marathon app.", 
      "required": false, 
      "title": "Marathon app name", 
      "type": "string"
    }, 
    "marathon_service_port": {
      "description": "Task port associated with marathon service port. If Marathon app has multiple service ports, this is required. Else, the first task port is used.", 
      "required": false, 
      "title": "Marathon service port", 
      "type": "integer"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "prefixes": {
      "description": "Configure IP address prefix(es).", 
      "items": {
        "$ref": "ALBIpAddrPrefix
      }, 
      "required": false, 
      "title": "Prefixes", 
      "type": "array"
    }, 
    "ranges": {
      "description": "Configure IP address range(s).", 
      "items": {
        "$ref": "ALBIpAddrRange
      }, 
      "required": false, 
      "title": "Ranges", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "IpAddrGroup", 
  "type": "object"
}

ALBIpAddrGroupApiResponse (type)

{
  "additionalProperties": false, 
  "description": "IpAddrGroupApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBIpAddrGroupApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of IpAddrGroup", 
      "items": {
        "$ref": "ALBIpAddrGroup
      }, 
      "required": false, 
      "title": "Array of IpAddrGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IpAddrGroupApiResponse", 
  "type": "object"
}

ALBIpAddrMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddrMatch object", 
  "id": "ALBIpAddrMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "addrs": {
      "description": "IP address(es).", 
      "items": {
        "$ref": "ALBIpAddr
      }, 
      "required": false, 
      "title": "Addrs", 
      "type": "array"
    }, 
    "group_paths": {
      "description": "path of IP address group(s). It is a reference to an object of type IpAddrGroup.", 
      "items": {
        "type": "string"
      }, 
      "ref": "rel1", 
      "required": false, 
      "title": "Group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBDnsPolicy"
          ], 
          "relationshipType": "ALB_DNSPOLICY_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBHTTPPolicySet"
          ], 
          "relationshipType": "ALB_HTTPPOLICYSET_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBL4PolicySet"
          ], 
          "relationshipType": "ALB_L4POLICYSET_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBNetworkSecurityPolicy"
          ], 
          "relationshipType": "ALB_NETWORKSECURITYPOLICY_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBSSOPolicy"
          ], 
          "relationshipType": "ALB_SSOPOLICY_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }
      ]
    }, 
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "prefixes": {
      "description": "IP address prefix(es).", 
      "items": {
        "$ref": "ALBIpAddrPrefix
      }, 
      "required": false, 
      "title": "Prefixes", 
      "type": "array"
    }, 
    "ranges": {
      "description": "IP address range(s).", 
      "items": {
        "$ref": "ALBIpAddrRange
      }, 
      "required": false, 
      "title": "Ranges", 
      "type": "array"
    }
  }, 
  "title": "IpAddrMatch", 
  "type": "object"
}

ALBIpAddrPort (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddrPort object", 
  "id": "ALBIpAddrPort", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "hostname": {
      "description": "Hostname of server. One of IP address or hostname should be set.", 
      "required": false, 
      "title": "Hostname", 
      "type": "string"
    }, 
    "ip": {
      "$ref": "ALBIpAddr, 
      "description": "IP Address of host. One of IP address or hostname should be set.", 
      "required": false, 
      "title": "Ip"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "port": {
      "description": "Port number of server. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": true, 
      "title": "Port", 
      "type": "integer"
    }
  }, 
  "title": "IpAddrPort", 
  "type": "object"
}

ALBIpAddrPrefix (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddrPrefix object", 
  "id": "ALBIpAddrPrefix", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip_addr": {
      "$ref": "ALBIpAddr, 
      "description": "Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str  type ref.", 
      "required": true, 
      "title": "Ip addr"
    }, 
    "mask": {
      "description": "Number of mask.", 
      "required": true, 
      "title": "Mask", 
      "type": "integer"
    }
  }, 
  "title": "IpAddrPrefix", 
  "type": "object"
}

ALBIpAddrRange (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer IpAddrRange object", 
  "id": "ALBIpAddrRange", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "begin": {
      "$ref": "ALBIpAddr, 
      "description": "Starting IP address of the range.", 
      "required": true, 
      "title": "Begin"
    }, 
    "end": {
      "$ref": "ALBIpAddr, 
      "description": "Ending IP address of the range.", 
      "required": true, 
      "title": "End"
    }
  }, 
  "title": "IpAddrRange", 
  "type": "object"
}

ALBIpAddrType (type)

{
  "description": "Valid ENUM values for ALBIpAddrType", 
  "enum": [
    "V4", 
    "DNS", 
    "V6"
  ], 
  "id": "ALBIpAddrType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "IpAddrType type", 
  "type": "string"
}

ALBIpAddressVersions (type)

{
  "description": "Valid ENUM values for ALBIpAddressVersions", 
  "enum": [
    "V4_ONLY", 
    "V6_ONLY", 
    "V4_V6"
  ], 
  "id": "ALBIpAddressVersions", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "IpAddressVersions type", 
  "type": "string"
}

ALBKeyValue (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer KeyValue object", 
  "id": "ALBKeyValue", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "key": {
      "description": "Key.", 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "description": "Value.", 
      "required": false, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "KeyValue", 
  "type": "object"
}

ALBL4ConnectionPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4ConnectionPolicy object", 
  "id": "ALBL4ConnectionPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "rules": {
      "description": "Rules to apply when a new transport connection is setup.", 
      "items": {
        "$ref": "ALBL4Rule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "L4ConnectionPolicy", 
  "type": "object"
}

ALBL4Policies (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4Policies object", 
  "id": "ALBL4Policies", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "index": {
      "description": "Index of the virtual service L4 policy set.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "l4_policy_set_path": {
      "description": "ID of the virtual service L4 policy set. It is a reference to an object of type L4PolicySet.", 
      "required": true, 
      "title": "L4 policy set path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_L4POLICYSET_RELATIONSHIP", 
          "rightType": [
            "ALBL4PolicySet"
          ]
        }
      ]
    }
  }, 
  "title": "L4Policies", 
  "type": "object"
}

ALBL4PolicySet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4PolicySet object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBL4PolicySet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "is_internal_policy": {
      "default": false, 
      "description": "Placeholder for description of property is_internal_policy of obj type L4PolicySet field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is internal policy", 
      "type": "boolean"
    }, 
    "l4_connection_policy": {
      "$ref": "ALBL4ConnectionPolicy, 
      "description": "Policy to apply when a new transport connection is setup.", 
      "required": false, 
      "title": "L4 connection policy"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "L4PolicySet", 
  "type": "object"
}

ALBL4PolicySetApiResponse (type)

{
  "additionalProperties": false, 
  "description": "L4PolicySetApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBL4PolicySetApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of L4PolicySet", 
      "items": {
        "$ref": "ALBL4PolicySet
      }, 
      "required": false, 
      "title": "Array of L4PolicySet", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "L4PolicySetApiResponse", 
  "type": "object"
}

ALBL4Rule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4Rule object", 
  "id": "ALBL4Rule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBL4RuleAction, 
      "description": "Action to be performed upon successful rule match.", 
      "required": false, 
      "title": "Action"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable the rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBL4RuleMatchTarget, 
      "description": "Match criteria of the rule.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "L4Rule", 
  "type": "object"
}

ALBL4RuleAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4RuleAction object", 
  "id": "ALBL4RuleAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "select_pool": {
      "$ref": "ALBL4RuleActionSelectPool, 
      "description": "Indicates pool or pool-group selection on rule match.", 
      "required": false, 
      "title": "Select pool"
    }
  }, 
  "title": "L4RuleAction", 
  "type": "object"
}

ALBL4RuleActionSelectPool (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4RuleActionSelectPool object", 
  "id": "ALBL4RuleActionSelectPool", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action_type": {
      "$ref": "ALBL4RuleActionSelectPoolType, 
      "description": "Indicates action to take on rule match. Enum options - L4_RULE_ACTION_SELECT_POOL, L4_RULE_ACTION_SELECT_POOLGROUP. Allowed in Basic(Allowed values- L4_RULE_ACTION_SELECT_POOL) edition, Essentials(Allowed values- L4_RULE_ACTION_SELECT_POOL) edition, Enterprise edition.", 
      "required": true, 
      "title": "Action type"
    }, 
    "pool_group_path": {
      "description": "ID of the pool group to serve the request. It is a reference to an object of type PoolGroup. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Pool group path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBL4PolicySet"
          ], 
          "relationshipType": "ALB_L4POLICYSET_ALB_POOLGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroup"
          ]
        }
      ]
    }, 
    "pool_path": {
      "description": "ID of the pool of servers to serve the request. It is a reference to an object of type Pool.", 
      "required": false, 
      "title": "Pool path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBL4PolicySet"
          ], 
          "relationshipType": "ALB_L4POLICYSET_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }
  }, 
  "title": "L4RuleActionSelectPool", 
  "type": "object"
}

ALBL4RuleActionSelectPoolType (type)

{
  "description": "Valid ENUM values for ALBL4RuleActionSelectPoolType", 
  "enum": [
    "L4_RULE_ACTION_SELECT_POOL", 
    "L4_RULE_ACTION_SELECT_POOLGROUP"
  ], 
  "id": "ALBL4RuleActionSelectPoolType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "L4RuleActionSelectPoolType type", 
  "type": "string"
}

ALBL4RuleMatchTarget (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4RuleMatchTarget object", 
  "id": "ALBL4RuleMatchTarget", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "IP addresses to match against client IP. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "port": {
      "$ref": "ALBL4RulePortMatch, 
      "description": "Port number to match against Virtual Service listner port.", 
      "required": false, 
      "title": "Port"
    }, 
    "protocol": {
      "$ref": "ALBL4RuleProtocolMatch, 
      "description": "TCP/UDP/ICMP protocol to match against transport protocol. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Protocol"
    }
  }, 
  "title": "L4RuleMatchTarget", 
  "type": "object"
}

ALBL4RulePortMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4RulePortMatch object", 
  "id": "ALBL4RulePortMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for Virtual Service port matching. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "port_ranges": {
      "description": "Range of TCP/UDP port numbers of the Virtual Service.", 
      "items": {
        "$ref": "ALBPortRange
      }, 
      "required": false, 
      "title": "Port ranges", 
      "type": "array"
    }, 
    "ports": {
      "description": "Virtual Service's listening port(s). Allowed values are 1-65535.", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Ports", 
      "type": "array"
    }
  }, 
  "title": "L4RulePortMatch", 
  "type": "object"
}

ALBL4RuleProtocolMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer L4RuleProtocolMatch object", 
  "id": "ALBL4RuleProtocolMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for transport protocol matching. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "protocol": {
      "$ref": "ALBProtocol, 
      "description": "Transport protocol to match. Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP.", 
      "required": true, 
      "title": "Protocol"
    }
  }, 
  "title": "L4RuleProtocolMatch", 
  "type": "object"
}

ALBLbAlgorithm (type)

{
  "description": "Valid ENUM values for ALBLbAlgorithm", 
  "enum": [
    "LB_ALGORITHM_LEAST_CONNECTIONS", 
    "LB_ALGORITHM_ROUND_ROBIN", 
    "LB_ALGORITHM_FASTEST_RESPONSE", 
    "LB_ALGORITHM_CONSISTENT_HASH", 
    "LB_ALGORITHM_LEAST_LOAD", 
    "LB_ALGORITHM_FEWEST_SERVERS", 
    "LB_ALGORITHM_RANDOM", 
    "LB_ALGORITHM_FEWEST_TASKS", 
    "LB_ALGORITHM_NEAREST_SERVER", 
    "LB_ALGORITHM_CORE_AFFINITY", 
    "LB_ALGORITHM_TOPOLOGY"
  ], 
  "id": "ALBLbAlgorithm", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LbAlgorithm type", 
  "type": "string"
}

ALBLbAlgorithmConsistentHash (type)

{
  "description": "Valid ENUM values for ALBLbAlgorithmConsistentHash", 
  "enum": [
    "LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS", 
    "LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT", 
    "LB_ALGORITHM_CONSISTENT_HASH_URI", 
    "LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER", 
    "LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING", 
    "LB_ALGORITHM_CONSISTENT_HASH_CALLID"
  ], 
  "id": "ALBLbAlgorithmConsistentHash", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LbAlgorithmConsistentHash type", 
  "type": "string"
}

ALBLdapAuthSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer LdapAuthSettings object", 
  "id": "ALBLdapAuthSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "base_dn": {
      "description": "The LDAP base DN. For example, avinetworks.com would be DC=avinetworks,DC=com.", 
      "required": false, 
      "title": "Base dn", 
      "type": "string"
    }, 
    "bind_as_administrator": {
      "default": true, 
      "description": "LDAP administrator credentials are used to search for users and group memberships. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Bind as administrator", 
      "type": "boolean"
    }, 
    "email_attribute": {
      "default": "email", 
      "description": "LDAP attribute that refers to user email. Default value when not specified in API or module is interpreted by ALB Controller as email.", 
      "required": false, 
      "title": "Email attribute", 
      "type": "string"
    }, 
    "full_name_attribute": {
      "default": "name", 
      "description": "LDAP attribute that refers to user's full name. Default value when not specified in API or module is interpreted by ALB Controller as name.", 
      "required": false, 
      "title": "Full name attribute", 
      "type": "string"
    }, 
    "port": {
      "default": 389, 
      "description": "Query the LDAP servers on this port. Default value when not specified in API or module is interpreted by ALB Controller as 389.", 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }, 
    "security_mode": {
      "$ref": "ALBAuthLdapSecurityMode, 
      "description": "LDAP connection security mode. Enum options - AUTH_LDAP_SECURE_NONE, AUTH_LDAP_SECURE_USE_LDAPS.", 
      "required": false, 
      "title": "Security mode"
    }, 
    "server": {
      "description": "LDAP server IP address or Hostname. Use IP address if an auth profile is used to configure Virtual Service. Minimum of 1 items required.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Server", 
      "type": "array"
    }, 
    "settings": {
      "$ref": "ALBLdapDirectorySettings, 
      "description": "LDAP full directory configuration with administrator credentials.", 
      "required": false, 
      "title": "Settings"
    }, 
    "user_bind": {
      "$ref": "ALBLdapUserBindSettings, 
      "description": "LDAP anonymous bind configuration.", 
      "required": false, 
      "title": "User bind"
    }
  }, 
  "title": "LdapAuthSettings", 
  "type": "object"
}

ALBLdapDirectorySettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer LdapDirectorySettings object", 
  "id": "ALBLdapDirectorySettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "admin_bind_dn": {
      "description": "LDAP Admin User DN. Administrator credentials are required to search for users under user search DN or groups under group search DN.", 
      "required": false, 
      "title": "Admin bind dn", 
      "type": "string"
    }, 
    "group_filter": {
      "default": "(objectClass=*)", 
      "description": "Group filter is used to identify groups during search. Default value when not specified in API or module is interpreted by ALB Controller as (objectClass=(STAR)).", 
      "required": false, 
      "title": "Group filter", 
      "type": "string"
    }, 
    "group_member_attribute": {
      "default": "member", 
      "description": "LDAP group attribute that identifies each of the group members. Default value when not specified in API or module is interpreted by ALB Controller as member.", 
      "required": false, 
      "title": "Group member attribute", 
      "type": "string"
    }, 
    "group_member_is_full_dn": {
      "default": true, 
      "description": "Group member entries contain full DNs instead of just user id attribute values. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Group member is full dn", 
      "type": "boolean"
    }, 
    "group_search_dn": {
      "description": "LDAP group search DN is the root of search for a given group in the LDAP directory. Only matching groups present in this LDAP directory sub-tree will be checked for user membership.", 
      "required": false, 
      "title": "Group search dn", 
      "type": "string"
    }, 
    "group_search_scope": {
      "$ref": "ALBAuthLdapSearchScope, 
      "default": "AUTH_LDAP_SCOPE_SUBTREE", 
      "description": "LDAP group search scope defines how deep to search for the group starting from the group search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Default value when not specified in API or module is interpreted by ALB Controller as AUTH_LDAP_SCOPE_SUBTREE.", 
      "required": false, 
      "title": "Group search scope"
    }, 
    "ignore_referrals": {
      "default": false, 
      "description": "During user or group search, ignore searching referrals. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Ignore referrals", 
      "type": "boolean"
    }, 
    "password": {
      "description": "LDAP Admin User Password.", 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "user_attributes": {
      "description": "LDAP user attributes to fetch on a successful user bind.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "User attributes", 
      "type": "array"
    }, 
    "user_id_attribute": {
      "description": "LDAP user id attribute is the login attribute that uniquely identifies a single user record.", 
      "required": false, 
      "title": "User id attribute", 
      "type": "string"
    }, 
    "user_search_dn": {
      "description": "LDAP user search DN is the root of search for a given user in the LDAP directory. Only user records present in this LDAP directory sub-tree will be validated.", 
      "required": false, 
      "title": "User search dn", 
      "type": "string"
    }, 
    "user_search_scope": {
      "$ref": "ALBAuthLdapSearchScope, 
      "default": "AUTH_LDAP_SCOPE_ONE", 
      "description": "LDAP user search scope defines how deep to search for the user starting from user search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Default value when not specified in API or module is interpreted by ALB Controller as AUTH_LDAP_SCOPE_ONE.", 
      "required": false, 
      "title": "User search scope"
    }
  }, 
  "title": "LdapDirectorySettings", 
  "type": "object"
}

ALBLdapUserBindSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer LdapUserBindSettings object", 
  "id": "ALBLdapUserBindSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dn_template": {
      "description": "LDAP user DN pattern is used to bind LDAP user after replacing the user token with real username.", 
      "required": false, 
      "title": "Dn template", 
      "type": "string"
    }, 
    "token": {
      "default": "<user>", 
      "description": "LDAP token is replaced with real user name in the user DN pattern. Default value when not specified in API or module is interpreted by ALB Controller as <user>.", 
      "required": false, 
      "title": "Token", 
      "type": "string"
    }, 
    "user_attributes": {
      "description": "LDAP user attributes to fetch on a successful user bind.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "User attributes", 
      "type": "array"
    }, 
    "user_id_attribute": {
      "description": "LDAP user id attribute is the login attribute that uniquely identifies a single user record.", 
      "required": false, 
      "title": "User id attribute", 
      "type": "string"
    }
  }, 
  "title": "LdapUserBindSettings", 
  "type": "object"
}

ALBLocationHdrMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer LocationHdrMatch object", 
  "id": "ALBLocationHdrMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBHdrMatchOperation, 
      "description": "Criterion to use for matching location header value in the HTTP response. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "value": {
      "description": "String value(s) in the location header.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Value", 
      "type": "array"
    }
  }, 
  "title": "LocationHdrMatch", 
  "type": "object"
}

ALBLogAction (type)

{
  "description": "Valid ENUM values for ALBLogAction", 
  "enum": [
    "LOG_FIELD_REMOVE", 
    "LOG_FIELD_MASKOFF"
  ], 
  "id": "ALBLogAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LogAction type", 
  "type": "string"
}

ALBLogStreamingFormatType (type)

{
  "description": "Valid ENUM values for ALBLogStreamingFormatType", 
  "enum": [
    "LOG_STREAMING_FORMAT_JSON_FULL", 
    "LOG_STREAMING_FORMAT_JSON_SELECTED"
  ], 
  "id": "ALBLogStreamingFormatType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LogStreamingFormatType type", 
  "type": "string"
}

ALBLogsProcessingType (type)

{
  "description": "Valid ENUM values for ALBLogsProcessingType", 
  "enum": [
    "LOGS_PROCESSING_NONE", 
    "LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND", 
    "LOGS_PROCESSING_AUTO_SYNC_AND_INDEX", 
    "LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND"
  ], 
  "id": "ALBLogsProcessingType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LogsProcessingType type", 
  "type": "string"
}

ALBLogsType (type)

{
  "description": "Valid ENUM values for ALBLogsType", 
  "enum": [
    "LOGS_SIGNIFICANT_ONLY", 
    "LOGS_UDF_ONLY", 
    "LOGS_UDF_SIGNIFICANT", 
    "LOGS_ALL"
  ], 
  "id": "ALBLogsType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "LogsType type", 
  "type": "string"
}

ALBMatchCase (type)

{
  "description": "Valid ENUM values for ALBMatchCase", 
  "enum": [
    "SENSITIVE", 
    "INSENSITIVE"
  ], 
  "id": "ALBMatchCase", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "MatchCase type", 
  "type": "string"
}

ALBMatchOperation (type)

{
  "description": "Valid ENUM values for ALBMatchOperation", 
  "enum": [
    "IS_IN", 
    "IS_NOT_IN"
  ], 
  "id": "ALBMatchOperation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "MatchOperation type", 
  "type": "string"
}

ALBMatchReplacePair (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer MatchReplacePair object", 
  "id": "ALBMatchReplacePair", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_string": {
      "description": "String to be matched.", 
      "required": true, 
      "title": "Match string", 
      "type": "string"
    }, 
    "replacement_string": {
      "$ref": "ALBReplaceStringVar, 
      "description": "Replacement string.", 
      "required": false, 
      "title": "Replacement string"
    }
  }, 
  "title": "MatchReplacePair", 
  "type": "object"
}

ALBMatchTarget (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer MatchTarget object", 
  "id": "ALBMatchTarget", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Configure client ip addresses.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "cookie": {
      "$ref": "ALBCookieMatch, 
      "description": "Configure HTTP cookie(s).", 
      "required": false, 
      "title": "Cookie"
    }, 
    "hdrs": {
      "description": "Configure HTTP header(s).", 
      "items": {
        "$ref": "ALBHdrMatch
      }, 
      "required": false, 
      "title": "Hdrs", 
      "type": "array"
    }, 
    "host_hdr": {
      "$ref": "ALBHostHdrMatch, 
      "description": "Configure the host header.", 
      "required": false, 
      "title": "Host hdr"
    }, 
    "method": {
      "$ref": "ALBMethodMatch, 
      "description": "Configure HTTP methods.", 
      "required": false, 
      "title": "Method"
    }, 
    "path": {
      "$ref": "ALBPathMatch, 
      "description": "Configure request paths.", 
      "required": false, 
      "title": "Path"
    }, 
    "protocol": {
      "$ref": "ALBProtocolMatch, 
      "description": "Configure the type of HTTP protocol.", 
      "required": false, 
      "title": "Protocol"
    }, 
    "query": {
      "$ref": "ALBQueryMatch, 
      "description": "Configure request query.", 
      "required": false, 
      "title": "Query"
    }, 
    "version": {
      "$ref": "ALBHTTPVersionMatch, 
      "description": "Configure versions of the HTTP protocol.", 
      "required": false, 
      "title": "Version"
    }, 
    "vs_port": {
      "$ref": "ALBPortMatch, 
      "description": "Configure virtual service ports.", 
      "required": false, 
      "title": "Vs port"
    }
  }, 
  "title": "MatchTarget", 
  "type": "object"
}

ALBMethodMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer MethodMatch object", 
  "id": "ALBMethodMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "methods": {
      "description": "Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Basic(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Essentials(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBHTTPMethod
      }, 
      "required": true, 
      "title": "Methods", 
      "type": "array"
    }
  }, 
  "title": "MethodMatch", 
  "type": "object"
}

ALBMetricsRealTimeUpdate (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer MetricsRealTimeUpdate object", 
  "id": "ALBMetricsRealTimeUpdate", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "duration": {
      "default": 30, 
      "description": "Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 30.", 
      "required": false, 
      "title": "Duration", 
      "type": "integer"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enables real time metrics collection. When deactivated, 6 hour view is the most granular the system will track. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": true, 
      "title": "Enabled", 
      "type": "boolean"
    }
  }, 
  "title": "MetricsRealTimeUpdate", 
  "type": "object"
}

ALBMicroServiceMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer MicroServiceMatch object", 
  "id": "ALBMicroServiceMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for Micro Service matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }
  }, 
  "title": "MicroServiceMatch", 
  "type": "object"
}

ALBNetworkFilter (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkFilter object", 
  "id": "ALBNetworkFilter", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "server_filter": {
      "description": "server_filter of NetworkFilter.", 
      "required": false, 
      "title": "Server filter", 
      "type": "string"
    }
  }, 
  "title": "NetworkFilter", 
  "type": "object"
}

ALBNetworkProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBNetworkProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connection_mirror": {
      "default": false, 
      "description": "When enabled, Avi mirrors all TCP fastpath connections to standby. Applicable only in Legacy HA Mode. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Connection mirror", 
      "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "profile": {
      "$ref": "ALBNetworkProfileUnion, 
      "description": "Placeholder for description of property profile of obj type NetworkProfile field type str  type ref.", 
      "required": true, 
      "title": "Profile"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "NetworkProfile", 
  "type": "object"
}

ALBNetworkProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "NetworkProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBNetworkProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of NetworkProfile", 
      "items": {
        "$ref": "ALBNetworkProfile
      }, 
      "required": false, 
      "title": "Array of NetworkProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NetworkProfileApiResponse", 
  "type": "object"
}

ALBNetworkProfileUnion (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkProfileUnion object", 
  "id": "ALBNetworkProfileUnion", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "tcp_fast_path_profile": {
      "$ref": "ALBTCPFastPathProfile, 
      "description": "Placeholder for description of property tcp_fast_path_profile of obj type NetworkProfileUnion field type str  type ref.", 
      "required": false, 
      "title": "Tcp fast path profile"
    }, 
    "tcp_proxy_profile": {
      "$ref": "ALBTCPProxyProfile, 
      "description": "Placeholder for description of property tcp_proxy_profile of obj type NetworkProfileUnion field type str  type ref.", 
      "required": false, 
      "title": "Tcp proxy profile"
    }, 
    "type": {
      "$ref": "ALBProtocolType, 
      "default": "PROTOCOL_TYPE_TCP_PROXY", 
      "description": "Configure one of either proxy or fast path profiles. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY. Allowed in Basic(Allowed values- PROTOCOL_TYPE_TCP_PROXY,PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH) edition, Essentials(Allowed values- PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as PROTOCOL_TYPE_TCP_PROXY.", 
      "required": true, 
      "title": "Type"
    }, 
    "udp_fast_path_profile": {
      "$ref": "ALBUDPFastPathProfile, 
      "description": "Placeholder for description of property udp_fast_path_profile of obj type NetworkProfileUnion field type str  type ref.", 
      "required": false, 
      "title": "Udp fast path profile"
    }, 
    "udp_proxy_profile": {
      "$ref": "ALBUDPProxyProfile, 
      "description": "Configure UDP Proxy network profile. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Udp proxy profile"
    }
  }, 
  "title": "NetworkProfileUnion", 
  "type": "object"
}

ALBNetworkSecurityMatchTarget (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkSecurityMatchTarget object", 
  "id": "ALBNetworkSecurityMatchTarget", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Placeholder for description of property client_ip of obj type NetworkSecurityMatchTarget field type str  type ref.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "microservice": {
      "$ref": "ALBMicroServiceMatch, 
      "description": "Placeholder for description of property microservice of obj type NetworkSecurityMatchTarget field type str  type ref.", 
      "required": false, 
      "title": "Microservice"
    }, 
    "vs_port": {
      "$ref": "ALBPortMatch, 
      "description": "Placeholder for description of property vs_port of obj type NetworkSecurityMatchTarget field type str  type ref.", 
      "required": false, 
      "title": "Vs port"
    }
  }, 
  "title": "NetworkSecurityMatchTarget", 
  "type": "object"
}

ALBNetworkSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkSecurityPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBNetworkSecurityPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of cloud configuration for Network Sec Policy. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rules": {
      "description": "Placeholder for description of property rules of obj type NetworkSecurityPolicy field type str  type array.", 
      "items": {
        "$ref": "ALBNetworkSecurityRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "NetworkSecurityPolicy", 
  "type": "object"
}

ALBNetworkSecurityPolicyActionRLParam (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkSecurityPolicyActionRLParam object", 
  "id": "ALBNetworkSecurityPolicyActionRLParam", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "burst_size": {
      "default": 0, 
      "description": "Maximum number of connections or requests or packets to be rate limited instantaneously. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": true, 
      "title": "Burst size", 
      "type": "integer"
    }, 
    "max_rate": {
      "description": "Maximum number of connections or requests or packets per second. Allowed values are 1-4294967295.", 
      "maximum": 4294967295, 
      "minimum": 1, 
      "required": true, 
      "title": "Max rate", 
      "type": "integer"
    }
  }, 
  "title": "NetworkSecurityPolicyActionRLParam", 
  "type": "object"
}

ALBNetworkSecurityPolicyActionType (type)

{
  "description": "Valid ENUM values for ALBNetworkSecurityPolicyActionType", 
  "enum": [
    "NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW", 
    "NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY", 
    "NETWORK_SECURITY_POLICY_ACTION_TYPE_RATE_LIMIT"
  ], 
  "id": "ALBNetworkSecurityPolicyActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "NetworkSecurityPolicyActionType type", 
  "type": "string"
}

ALBNetworkSecurityPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "NetworkSecurityPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBNetworkSecurityPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of NetworkSecurityPolicy", 
      "items": {
        "$ref": "ALBNetworkSecurityPolicy
      }, 
      "required": false, 
      "title": "Array of NetworkSecurityPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NetworkSecurityPolicyApiResponse", 
  "type": "object"
}

ALBNetworkSecurityRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer NetworkSecurityRule object", 
  "id": "ALBNetworkSecurityRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBNetworkSecurityPolicyActionType, 
      "description": "Enum options - NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW, NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY, NETWORK_SECURITY_POLICY_ACTION_TYPE_RATE_LIMIT. Allowed in Basic(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Essentials(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Enterprise edition.", 
      "required": true, 
      "title": "Action"
    }, 
    "age": {
      "default": 0, 
      "description": "Time in minutes after which rule will be deleted. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Age", 
      "type": "integer"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "enable": {
      "description": "Placeholder for description of property enable of obj type NetworkSecurityRule field type str  type boolean.", 
      "required": true, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "log": {
      "default": false, 
      "description": "Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Log", 
      "type": "boolean"
    }, 
    "match": {
      "$ref": "ALBNetworkSecurityMatchTarget, 
      "description": "Placeholder for description of property match of obj type NetworkSecurityRule field type str  type ref.", 
      "required": true, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "rl_param": {
      "$ref": "ALBNetworkSecurityPolicyActionRLParam, 
      "description": "Placeholder for description of property rl_param of obj type NetworkSecurityRule field type str  type ref.", 
      "required": false, 
      "title": "Rl param"
    }
  }, 
  "title": "NetworkSecurityRule", 
  "type": "object"
}

ALBOCSPConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer OCSPConfig object", 
  "id": "ALBOCSPConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "failed_ocsp_jobs_retry_interval": {
      "default": 3600, 
      "description": "Describes the Time Interval after which the next OCSP job needs to be scheduled in case of the OCSP job failures. Allowed values are 60-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 3600.", 
      "maximum": 86400, 
      "minimum": 60, 
      "required": false, 
      "title": "Failed ocsp jobs retry interval", 
      "type": "integer"
    }, 
    "max_tries": {
      "default": 10, 
      "description": "Maximum number of times the failed OCSP jobs can be scheduled. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "required": false, 
      "title": "Max tries", 
      "type": "integer"
    }, 
    "ocsp_req_interval": {
      "default": 86400, 
      "description": "Interval between the OCSP queries. Allowed values are 60-31536000. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 86400.", 
      "maximum": 31536000, 
      "minimum": 60, 
      "required": false, 
      "title": "Ocsp req interval", 
      "type": "integer"
    }, 
    "ocsp_resp_timeout": {
      "description": "Time in seconds that the system waits for a reply from the OCSP responder before dropping the connection. Unit is SEC.", 
      "required": false, 
      "title": "Ocsp resp timeout", 
      "type": "integer"
    }, 
    "responder_url_lists": {
      "description": "List of Responder URLs configured by user to do failover/override the AIA extension contained in the OCSP responder's SSL/TLS certificate.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Responder url lists", 
      "type": "array"
    }, 
    "url_action": {
      "$ref": "ALBOCSPResponderUrlAction, 
      "default": "OCSP_RESPONDER_URL_FAILOVER", 
      "description": "Describes the type of action to take with the Responder URLs. Enum options - OCSP_RESPONDER_URL_FAILOVER, OCSP_RESPONDER_URL_OVERRIDE. Default value when not specified in API or module is interpreted by ALB Controller as OCSP_RESPONDER_URL_FAILOVER.", 
      "required": false, 
      "title": "Url action"
    }
  }, 
  "title": "OCSPConfig", 
  "type": "object"
}

ALBOCSPResponderUrlAction (type)

{
  "description": "Valid ENUM values for ALBOCSPResponderUrlAction", 
  "enum": [
    "OCSP_RESPONDER_URL_FAILOVER", 
    "OCSP_RESPONDER_URL_OVERRIDE"
  ], 
  "id": "ALBOCSPResponderUrlAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "OCSPResponderUrlAction type", 
  "type": "string"
}

ALBOperationMode (type)

{
  "description": "Valid ENUM values for ALBOperationMode", 
  "enum": [
    "DETECTION", 
    "MITIGATION"
  ], 
  "id": "ALBOperationMode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "OperationMode type", 
  "type": "string"
}

ALBPGDeploymentRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PGDeploymentRule object", 
  "id": "ALBPGDeploymentRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "metric_id": {
      "default": "health.health_score_value", 
      "description": "metric_id of PGDeploymentRule. Default value when not specified in API or module is interpreted by ALB Controller as health.health_score_value.", 
      "required": false, 
      "title": "Metric id", 
      "type": "string"
    }, 
    "operator": {
      "$ref": "ALBComparisonOperator, 
      "default": "CO_GE", 
      "description": "Enum options - CO_EQ, CO_GT, CO_GE, CO_LT, CO_LE, CO_NE. Default value when not specified in API or module is interpreted by ALB Controller as CO_GE.", 
      "required": false, 
      "title": "Operator"
    }, 
    "threshold": {
      "description": "metric threshold that is used as the pass fail. If it is not provided then it will simply compare it with current pool vs new pool.", 
      "required": false, 
      "title": "Threshold", 
      "type": "number"
    }
  }, 
  "title": "PGDeploymentRule", 
  "type": "object"
}

ALBPKIProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PKIProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBPKIProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "ca_certs": {
      "description": "List of Certificate Authorities (Root and Intermediate) trusted that is used for certificate validation.", 
      "items": {
        "$ref": "ALBSSLCertificate
      }, 
      "required": false, 
      "title": "Ca certs", 
      "type": "array"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "crl_check": {
      "default": true, 
      "description": "When enabled, Avi will verify via CRL checks that certificates in the trust chain have not been revoked. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Crl check", 
      "type": "boolean"
    }, 
    "crls": {
      "description": "Certificate Revocation Lists.", 
      "items": {
        "$ref": "ALBCRL
      }, 
      "required": false, 
      "title": "Crls", 
      "type": "array"
    }, 
    "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"
    }, 
    "ignore_peer_chain": {
      "default": true, 
      "description": "When enabled, Avi will not trust Intermediate and Root certs presented by a client. Instead, only the chain certs configured in the Certificate Authority section will be used to verify trust of the client's cert. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Special default for Basic edition is true, Essentials edition is true, Enterprise is False. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Ignore peer chain", 
      "type": "boolean"
    }, 
    "is_federated": {
      "default": false, 
      "description": "This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is federated", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "validate_only_leaf_crl": {
      "default": true, 
      "description": "When enabled, Avi will only validate the revocation status of the leaf certificate using CRL. To enable validation for the entire chain, disable this option and provide all the relevant CRLs. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Validate only leaf crl", 
      "type": "boolean"
    }
  }, 
  "title": "PKIProfile", 
  "type": "object"
}

ALBPKIProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "PKIProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBPKIProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of PKIProfile", 
      "items": {
        "$ref": "ALBPKIProfile
      }, 
      "required": false, 
      "title": "Array of PKIProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PKIProfileApiResponse", 
  "type": "object"
}

ALBPathMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PathMatch object", 
  "id": "ALBPathMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBStringOperation, 
      "default": "CONTAINS", 
      "description": "Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as CONTAINS.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "match_str": {
      "description": "String values.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Match str", 
      "type": "array"
    }, 
    "string_group_paths": {
      "description": "path of the string group(s). It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "String group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBHTTPPolicySet"
          ], 
          "relationshipType": "ALB_HTTPPOLICYSET_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBSSOPolicy"
          ], 
          "relationshipType": "ALB_SSOPOLICY_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBWafPolicyPSMGroup"
          ], 
          "relationshipType": "ALB_WAFPOLICYPSMGROUP_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }
  }, 
  "title": "PathMatch", 
  "type": "object"
}

ALBPerformanceLimits (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PerformanceLimits object", 
  "id": "ALBPerformanceLimits", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "max_concurrent_connections": {
      "description": "The maximum number of concurrent client conections allowed to the Virtual Service.", 
      "required": false, 
      "title": "Max concurrent connections", 
      "type": "integer"
    }, 
    "max_throughput": {
      "description": "The maximum throughput per second for all clients allowed through the client side of the Virtual Service.", 
      "required": false, 
      "title": "Max throughput", 
      "type": "integer"
    }
  }, 
  "title": "PerformanceLimits", 
  "type": "object"
}

ALBPersistenceProfileType (type)

{
  "description": "Valid ENUM values for ALBPersistenceProfileType", 
  "enum": [
    "PERSISTENCE_TYPE_CLIENT_IP_ADDRESS", 
    "PERSISTENCE_TYPE_HTTP_COOKIE", 
    "PERSISTENCE_TYPE_TLS", 
    "PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS", 
    "PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER", 
    "PERSISTENCE_TYPE_APP_COOKIE", 
    "PERSISTENCE_TYPE_GSLB_SITE"
  ], 
  "id": "ALBPersistenceProfileType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "PersistenceProfileType type", 
  "type": "string"
}

ALBPersistentServerHMDownRecovery (type)

{
  "description": "Valid ENUM values for ALBPersistentServerHMDownRecovery", 
  "enum": [
    "HM_DOWN_PICK_NEW_SERVER", 
    "HM_DOWN_ABORT_CONNECTION", 
    "HM_DOWN_CONTINUE_PERSISTENT_SERVER"
  ], 
  "id": "ALBPersistentServerHMDownRecovery", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "PersistentServerHMDownRecovery type", 
  "type": "string"
}

ALBPlacementNetwork (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PlacementNetwork object", 
  "id": "ALBPlacementNetwork", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "network_name": {
      "description": "It is a reference to an object of type Network.", 
      "required": true, 
      "title": "Network name", 
      "type": "string"
    }, 
    "subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Placeholder for description of property subnet of obj type PlacementNetwork field type str  type ref.", 
      "required": true, 
      "title": "Subnet"
    }
  }, 
  "title": "PlacementNetwork", 
  "type": "object"
}

ALBPool (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Pool object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBPool", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "analytics_policy": {
      "$ref": "ALBPoolAnalyticsPolicy, 
      "description": "Determines analytics settings for the pool.", 
      "required": false, 
      "title": "Analytics policy"
    }, 
    "analytics_profile_path": {
      "description": "Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.", 
      "required": false, 
      "title": "Analytics profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_ANALYTICSPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBAnalyticsProfile"
          ]
        }
      ]
    }, 
    "apic_epg_name": {
      "description": "Synchronize Cisco APIC EPG members with pool servers.", 
      "required": false, 
      "title": "Apic epg name", 
      "type": "string"
    }, 
    "application_persistence_profile_path": {
      "description": "Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type ApplicationPersistenceProfile.", 
      "required": false, 
      "title": "Application persistence profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_APPLICATIONPERSISTENCEPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBApplicationPersistenceProfile"
          ]
        }
      ]
    }, 
    "autoscale_launch_config_path": {
      "description": "If configured then Avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type AutoScaleLaunchConfig.", 
      "required": false, 
      "title": "Autoscale launch config path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_AUTOSCALELAUNCHCONFIG_RELATIONSHIP", 
          "rightType": [
            "ALBAutoScaleLaunchConfig"
          ]
        }
      ]
    }, 
    "autoscale_networks": {
      "description": "Network Ids for the launch configuration.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Autoscale networks", 
      "type": "array"
    }, 
    "autoscale_policy_path": {
      "description": "Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy.", 
      "required": false, 
      "title": "Autoscale policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_SERVERAUTOSCALEPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBServerAutoScalePolicy"
          ]
        }
      ]
    }, 
    "capacity_estimation": {
      "default": false, 
      "description": "Inline estimation of capacity of servers. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Capacity estimation", 
      "type": "boolean"
    }, 
    "capacity_estimation_ttfb_thresh": {
      "default": 0, 
      "description": "The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - 'Automatic'. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 5000, 
      "minimum": 0, 
      "required": false, 
      "title": "Capacity estimation ttfb thresh", 
      "type": "integer"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of cloud configuration for Pool. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "conn_pool_properties": {
      "$ref": "ALBConnPoolProperties, 
      "description": "Connnection pool properties.", 
      "required": false, 
      "title": "Conn pool properties"
    }, 
    "connection_ramp_duration": {
      "default": 0, 
      "description": "Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for LB algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - 'Immediate'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 10. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 300, 
      "minimum": 0, 
      "required": false, 
      "title": "Connection ramp duration", 
      "type": "integer"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "default_server_port": {
      "default": 80, 
      "description": "Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption. Allowed values are 1-65535. Default value when not specified in API or module is interpreted by ALB Controller as 80.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Default server port", 
      "type": "integer"
    }, 
    "delete_server_on_dns_refresh": {
      "default": true, 
      "description": "Indicates whether existing IPs are disabled(false) or deleted(true) on dns hostname refreshDetail -- On a dns refresh, some IPs set on pool may no longer be returned by the resolver. These IPs are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Delete server on dns refresh", 
      "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"
    }, 
    "domain_name": {
      "description": "Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain name", 
      "type": "array"
    }, 
    "east_west": {
      "description": "Inherited config from VirtualService.", 
      "required": false, 
      "title": "East west", 
      "type": "boolean"
    }, 
    "enable_http2": {
      "default": false, 
      "description": "Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable http2", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "external_autoscale_groups": {
      "description": "Names of external auto-scale groups for pool servers. Currently available only for AWS and Azure.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "External autoscale groups", 
      "type": "array"
    }, 
    "fail_action": {
      "$ref": "ALBFailAction, 
      "description": "Enable an action - Close Connection, HTTP Redirect or Local HTTP Response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure.", 
      "required": false, 
      "title": "Fail action"
    }, 
    "fewest_tasks_feedback_delay": {
      "default": 10, 
      "description": "Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "maximum": 300, 
      "minimum": 1, 
      "required": false, 
      "title": "Fewest tasks feedback delay", 
      "type": "integer"
    }, 
    "graceful_disable_timeout": {
      "default": 1, 
      "description": "Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections  to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - 'Immediate', -1 - 'Infinite'. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 7200, 
      "minimum": -1, 
      "required": false, 
      "title": "Graceful disable timeout", 
      "type": "integer"
    }, 
    "group_paths": {
      "description": "A list of NSX Groups where the Servers for the Pool are created .", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Group paths", 
      "type": "array"
    }, 
    "gslb_sp_enabled": {
      "description": "Indicates if the pool is a site-persistence pool. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Gslb sp enabled", 
      "type": "boolean"
    }, 
    "health_monitor_paths": {
      "description": "Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each Service Engine and mark a server up or down based on the response. The Passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type HealthMonitor. Maximum of 50 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Health monitor paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_HEALTHMONITOR_RELATIONSHIP", 
          "rightType": [
            "ALBHealthMonitor"
          ]
        }
      ]
    }, 
    "host_check_enabled": {
      "default": false, 
      "description": "Enable common name check for server certificate. If enabled and no explicit domain name is specified, Avi will use the incoming host header to do the match. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Host check enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ignore_server_port": {
      "default": false, 
      "description": "Ignore the server port in building the load balancing state.Applicable only for consistent hash load balancing algorithm or Disable Port translation (use_service_port) use cases. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Ignore server port", 
      "type": "boolean"
    }, 
    "inline_health_monitor": {
      "default": true, 
      "description": "The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Inline health monitor", 
      "type": "boolean"
    }, 
    "ipaddrgroup_path": {
      "description": "Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup.", 
      "required": false, 
      "title": "Ipaddrgroup path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_IPADDRGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBIpAddrGroup"
          ]
        }
      ]
    }, 
    "lb_algorithm": {
      "$ref": "ALBLbAlgorithm, 
      "default": "LB_ALGORITHM_LEAST_CONNECTIONS", 
      "description": "The load balancing algorithm will pick a server within the pool's list of available servers. Values LB_ALGORITHM_NEAREST_SERVER and LB_ALGORITHM_TOPOLOGY are only allowed for GSLB pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed in Basic(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Essentials(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_LEAST_CONNECTIONS.", 
      "required": false, 
      "title": "Lb algorithm"
    }, 
    "lb_algorithm_consistent_hash_hdr": {
      "description": "HTTP header name to be used for the hash key.", 
      "required": false, 
      "title": "Lb algorithm consistent hash hdr", 
      "type": "string"
    }, 
    "lb_algorithm_core_nonaffinity": {
      "default": 2, 
      "description": "Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Lb algorithm core nonaffinity", 
      "type": "integer"
    }, 
    "lb_algorithm_hash": {
      "$ref": "ALBLbAlgorithmConsistentHash, 
      "default": "LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS", 
      "description": "Criteria used as a key for determining the hash between the client and  server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed in Basic(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Essentials(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.", 
      "required": false, 
      "title": "Lb algorithm hash"
    }, 
    "lookup_server_by_name": {
      "default": false, 
      "description": "Allow server lookup by name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Lookup server by name", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "max_concurrent_connections_per_server": {
      "default": 0, 
      "description": "The maximum number of concurrent connections allowed to each server within the pool. NOTE  applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Max concurrent connections per server", 
      "type": "integer"
    }, 
    "max_conn_rate_per_server": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit connections to each server.", 
      "required": false, 
      "title": "Max conn rate per server"
    }, 
    "min_health_monitors_up": {
      "description": "Minimum number of health monitors in UP state to mark server UP. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Min health monitors up", 
      "type": "integer"
    }, 
    "min_servers_up": {
      "description": "Minimum number of servers in UP state for marking the pool UP.", 
      "required": false, 
      "title": "Min servers up", 
      "type": "integer"
    }, 
    "networks": {
      "description": "(internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user.", 
      "items": {
        "$ref": "ALBNetworkFilter
      }, 
      "required": false, 
      "title": "Networks", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "pki_profile_path": {
      "description": "Avi will validate the SSL certificate present by a server against the selected PKI Profile. It is a reference to an object of type PKIProfile.", 
      "required": false, 
      "title": "Pki profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_PKIPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBPKIProfile"
          ]
        }
      ]
    }, 
    "placement_networks": {
      "description": "Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax  10-1-1-0/24. Use static routes in VRF configuration when pool servers are not directly connected but routable from the service engine.", 
      "items": {
        "$ref": "ALBPlacementNetwork
      }, 
      "required": false, 
      "title": "Placement networks", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "request_queue_depth": {
      "default": 128, 
      "description": "Minimum number of requests to be queued when pool is full. Allowed in Basic(Allowed values- 128) edition, Essentials(Allowed values- 128) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 128.", 
      "required": false, 
      "title": "Request queue depth", 
      "type": "integer"
    }, 
    "request_queue_enabled": {
      "default": false, 
      "description": "Enable request queue when pool is full. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Request queue enabled", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rewrite_host_header_to_server_name": {
      "default": false, 
      "description": "Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Rewrite host header to server name", 
      "type": "boolean"
    }, 
    "rewrite_host_header_to_sni": {
      "default": false, 
      "description": "If SNI server name is specified, rewrite incoming host header to the SNI server name. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Rewrite host header to sni", 
      "type": "boolean"
    }, 
    "routing_pool": {
      "default": false, 
      "description": "Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Routing pool", 
      "type": "boolean"
    }, 
    "server_name": {
      "description": "Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead.", 
      "required": false, 
      "title": "Server name", 
      "type": "string"
    }, 
    "server_reselect": {
      "$ref": "ALBHTTPServerReselect, 
      "description": "Server reselect configuration for HTTP requests.", 
      "required": false, 
      "title": "Server reselect"
    }, 
    "server_timeout": {
      "default": 0, 
      "description": "Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between AVI and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 21600000, 
      "minimum": 0, 
      "required": false, 
      "title": "Server timeout", 
      "type": "integer"
    }, 
    "servers": {
      "description": "The pool directs load balanced traffic to this list of destination servers. The servers can be configured by IP address, name, network or via IP Address Group. Maximum of 5000 items allowed.", 
      "items": {
        "$ref": "ALBServer
      }, 
      "required": false, 
      "title": "Servers", 
      "type": "array"
    }, 
    "service_metadata": {
      "description": "Metadata pertaining to the service provided by this Pool. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage.", 
      "required": false, 
      "title": "Service metadata", 
      "type": "string"
    }, 
    "sni_enabled": {
      "default": true, 
      "description": "Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Sni enabled", 
      "type": "boolean"
    }, 
    "ssl_key_and_certificate_path": {
      "description": "Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.", 
      "required": false, 
      "title": "Ssl key and certificate path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_SSLKEYANDCERTIFICATE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLKeyAndCertificate"
          ]
        }
      ]
    }, 
    "ssl_profile_path": {
      "description": "When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. It is a reference to an object of type SSLProfile.", 
      "required": false, 
      "title": "Ssl profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPool"
          ], 
          "relationshipType": "ALB_POOL_ALB_SSLPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLProfile"
          ]
        }
      ]
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tier1_path": {
      "description": "This tier1_lr field should be set same as VirtualService associated for NSX-T.", 
      "required": false, 
      "title": "Tier1 path", 
      "type": "string"
    }, 
    "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"
    }, 
    "use_service_port": {
      "default": false, 
      "description": "Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use service port", 
      "type": "boolean"
    }, 
    "vrf_name": {
      "description": "Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type VrfContext.", 
      "required": false, 
      "title": "Vrf name", 
      "type": "string"
    }
  }, 
  "title": "Pool", 
  "type": "object"
}

ALBPoolAnalyticsPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PoolAnalyticsPolicy object", 
  "id": "ALBPoolAnalyticsPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable_realtime_metrics": {
      "default": false, 
      "description": "Enable real time metrics for server and pool metrics eg. l4_server.xxx, l7_server.xxx. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable realtime metrics", 
      "type": "boolean"
    }
  }, 
  "title": "PoolAnalyticsPolicy", 
  "type": "object"
}

ALBPoolApiResponse (type)

{
  "additionalProperties": false, 
  "description": "PoolApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBPoolApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Pool", 
      "items": {
        "$ref": "ALBPool
      }, 
      "required": false, 
      "title": "Array of Pool", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PoolApiResponse", 
  "type": "object"
}

ALBPoolDeploymentState (type)

{
  "description": "Valid ENUM values for ALBPoolDeploymentState", 
  "enum": [
    "EVALUATION_IN_PROGRESS", 
    "IN_SERVICE", 
    "OUT_OF_SERVICE", 
    "EVALUATION_FAILED"
  ], 
  "id": "ALBPoolDeploymentState", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "PoolDeploymentState type", 
  "type": "string"
}

ALBPoolGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PoolGroup object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBPoolGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of cloud configuration for PoolGroup. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "created_by": {
      "description": "Name of the user who created the object.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "deactivate_primary_pool_on_down": {
      "default": false, 
      "description": "Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Deactivate primary pool on down", 
      "type": "boolean"
    }, 
    "deployment_policy_path": {
      "description": "When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type PoolGroupDeploymentPolicy.", 
      "required": false, 
      "title": "Deployment policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPoolGroup"
          ], 
          "relationshipType": "ALB_POOLGROUP_ALB_POOLGROUPDEPLOYMENTPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroupDeploymentPolicy"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "enable_http2": {
      "default": false, 
      "description": "Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable http2", 
      "type": "boolean"
    }, 
    "fail_action": {
      "$ref": "ALBFailAction, 
      "description": "Enable an action - Close Connection, HTTP Redirect, or Local HTTP Response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure.", 
      "required": false, 
      "title": "Fail action"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "implicit_priority_labels": {
      "default": false, 
      "description": "Whether an implicit set of priority labels is generated. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Implicit priority labels", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "members": {
      "description": "List of pool group members object of type PoolGroupMember.", 
      "items": {
        "$ref": "ALBPoolGroupMember
      }, 
      "required": false, 
      "title": "Members", 
      "type": "array"
    }, 
    "min_servers": {
      "default": 0, 
      "description": "The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Min servers", 
      "type": "integer"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "priority_labels_path": {
      "description": "path of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type PriorityLabels.", 
      "required": false, 
      "title": "Priority labels path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPoolGroup"
          ], 
          "relationshipType": "ALB_POOLGROUP_ALB_PRIORITYLABELS_RELATIONSHIP", 
          "rightType": [
            "ALBPriorityLabels"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_metadata": {
      "description": "Metadata pertaining to the service provided by this PoolGroup. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage.", 
      "required": false, 
      "title": "Service metadata", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "PoolGroup", 
  "type": "object"
}

ALBPoolGroupApiResponse (type)

{
  "additionalProperties": false, 
  "description": "PoolGroupApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBPoolGroupApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of PoolGroup", 
      "items": {
        "$ref": "ALBPoolGroup
      }, 
      "required": false, 
      "title": "Array of PoolGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PoolGroupApiResponse", 
  "type": "object"
}

ALBPoolGroupDeploymentPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PoolGroupDeploymentPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBPoolGroupDeploymentPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "auto_disable_old_prod_pools": {
      "default": true, 
      "description": "It will automatically disable old production pools once there is a new production candidate. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Auto disable old prod pools", 
      "type": "boolean"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "evaluation_duration": {
      "default": 300, 
      "description": "Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300.", 
      "maximum": 86400, 
      "minimum": 60, 
      "required": false, 
      "title": "Evaluation duration", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rules": {
      "description": "Placeholder for description of property rules of obj type PoolGroupDeploymentPolicy field type str  type array.", 
      "items": {
        "$ref": "ALBPGDeploymentRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }, 
    "scheme": {
      "$ref": "ALBPoolGroupDeploymentScheme, 
      "default": "BLUE_GREEN", 
      "description": "deployment scheme. Enum options - BLUE_GREEN, CANARY. Default value when not specified in API or module is interpreted by ALB Controller as BLUE_GREEN.", 
      "required": false, 
      "title": "Scheme"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_test_traffic_ratio": {
      "default": 100, 
      "description": "Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is RATIO. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Target test traffic ratio", 
      "type": "integer"
    }, 
    "test_traffic_ratio_rampup": {
      "default": 100, 
      "description": "Ratio of the traffic that is sent to the pool under test. test ratio of 100 means blue green. Allowed values are 1-100. Default value when not specified in API or module is interpreted by ALB Controller as 100.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Test traffic ratio rampup", 
      "type": "integer"
    }, 
    "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"
    }, 
    "webhook_path": {
      "description": "Webhook configured with URL that Avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type Webhook.", 
      "required": false, 
      "title": "Webhook path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPoolGroupDeploymentPolicy"
          ], 
          "relationshipType": "ALB_POOLGROUPDEPLOYMENTPOLICY_ALB_WEBHOOK_RELATIONSHIP", 
          "rightType": [
            "ALBWebhook"
          ]
        }
      ]
    }
  }, 
  "title": "PoolGroupDeploymentPolicy", 
  "type": "object"
}

ALBPoolGroupDeploymentPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "PoolGroupDeploymentPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBPoolGroupDeploymentPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of PoolGroupDeploymentPolicy", 
      "items": {
        "$ref": "ALBPoolGroupDeploymentPolicy
      }, 
      "required": false, 
      "title": "Array of PoolGroupDeploymentPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PoolGroupDeploymentPolicyApiResponse", 
  "type": "object"
}

ALBPoolGroupDeploymentScheme (type)

{
  "description": "Valid ENUM values for ALBPoolGroupDeploymentScheme", 
  "enum": [
    "BLUE_GREEN", 
    "CANARY"
  ], 
  "id": "ALBPoolGroupDeploymentScheme", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "PoolGroupDeploymentScheme type", 
  "type": "string"
}

ALBPoolGroupMember (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PoolGroupMember object", 
  "id": "ALBPoolGroupMember", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "deployment_state": {
      "$ref": "ALBPoolDeploymentState, 
      "description": "Pool deployment state used with the PG deployment policy. Enum options - EVALUATION_IN_PROGRESS, IN_SERVICE, OUT_OF_SERVICE, EVALUATION_FAILED.", 
      "required": false, 
      "title": "Deployment state"
    }, 
    "pool_path": {
      "description": "path of the pool. It is a reference to an object of type Pool.", 
      "required": true, 
      "title": "Pool path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBPoolGroup"
          ], 
          "relationshipType": "ALB_POOLGROUP_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }, 
    "priority_label": {
      "description": "All pools with same label are treated similarly in a pool group. A pool with a higher priority is selected, as long as the pool is eligible or an explicit policy chooses a different pool.", 
      "required": false, 
      "title": "Priority label", 
      "type": "string"
    }, 
    "ratio": {
      "default": 1, 
      "description": "Ratio of selecting eligible pools in the pool group. Allowed values are 1-1000. Special values are 0 - 'Do not select this pool for new connections'. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Ratio", 
      "type": "integer"
    }
  }, 
  "title": "PoolGroupMember", 
  "type": "object"
}

ALBPoolServer (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PoolServer object", 
  "id": "ALBPoolServer", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "hostname": {
      "description": "DNS resolvable name of the server. May be used in place of the IP address.", 
      "required": false, 
      "title": "Hostname", 
      "type": "string"
    }, 
    "ip": {
      "$ref": "ALBIpAddr, 
      "description": "IP address of the server in the poool.", 
      "required": true, 
      "title": "Ip"
    }, 
    "port": {
      "description": "Port of the pool server listening for HTTP/HTTPS. Default value is the default port in the pool. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }
  }, 
  "title": "PoolServer", 
  "type": "object"
}

ALBPortMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PortMatch object", 
  "id": "ALBPortMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "ports": {
      "description": "Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required.", 
      "items": {
        "type": "integer"
      }, 
      "required": true, 
      "title": "Ports", 
      "type": "array"
    }
  }, 
  "title": "PortMatch", 
  "type": "object"
}

ALBPortRange (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PortRange object", 
  "id": "ALBPortRange", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "end": {
      "description": "TCP/UDP port range end (inclusive). Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": true, 
      "title": "End", 
      "type": "integer"
    }, 
    "start": {
      "description": "TCP/UDP port range start (inclusive). Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": true, 
      "title": "Start", 
      "type": "integer"
    }
  }, 
  "title": "PortRange", 
  "type": "object"
}

ALBPriorityLabels (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer PriorityLabels object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBPriorityLabels", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "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"
    }, 
    "equivalent_labels": {
      "description": "Equivalent priority labels in descending order.", 
      "items": {
        "$ref": "ALBEquivalentLabels
      }, 
      "required": false, 
      "title": "Equivalent labels", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "PriorityLabels", 
  "type": "object"
}

ALBPriorityLabelsApiResponse (type)

{
  "additionalProperties": false, 
  "description": "PriorityLabelsApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBPriorityLabelsApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of PriorityLabels", 
      "items": {
        "$ref": "ALBPriorityLabels
      }, 
      "required": false, 
      "title": "Array of PriorityLabels", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PriorityLabelsApiResponse", 
  "type": "object"
}

ALBProtocol (type)

{
  "description": "Valid ENUM values for ALBProtocol", 
  "enum": [
    "PROTOCOL_ICMP", 
    "PROTOCOL_TCP", 
    "PROTOCOL_UDP"
  ], 
  "id": "ALBProtocol", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "Protocol type", 
  "type": "string"
}

ALBProtocolMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ProtocolMatch object", 
  "id": "ALBProtocolMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBMatchOperation, 
      "description": "Criterion to use for protocol matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "protocols": {
      "$ref": "ALBHTTPProtocol, 
      "description": "HTTP or HTTPS protocol. Enum options - HTTP, HTTPS.", 
      "required": true, 
      "title": "Protocols"
    }
  }, 
  "title": "ProtocolMatch", 
  "type": "object"
}

ALBProtocolParser (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ProtocolParser object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBProtocolParser", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "parser_code": {
      "description": "Command script provided inline.", 
      "required": true, 
      "title": "Parser code", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "ProtocolParser", 
  "type": "object"
}

ALBProtocolParserApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ProtocolParserApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBProtocolParserApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ProtocolParser", 
      "items": {
        "$ref": "ALBProtocolParser
      }, 
      "required": false, 
      "title": "Array of ProtocolParser", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ProtocolParserApiResponse", 
  "type": "object"
}

ALBProtocolType (type)

{
  "description": "Valid ENUM values for ALBProtocolType", 
  "enum": [
    "PROTOCOL_TYPE_TCP_PROXY", 
    "PROTOCOL_TYPE_TCP_FAST_PATH", 
    "PROTOCOL_TYPE_UDP_FAST_PATH", 
    "PROTOCOL_TYPE_UDP_PROXY"
  ], 
  "id": "ALBProtocolType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ProtocolType type", 
  "type": "string"
}

ALBProxyProtocolVersion (type)

{
  "description": "Valid ENUM values for ALBProxyProtocolVersion", 
  "enum": [
    "PROXY_PROTOCOL_VERSION_1", 
    "PROXY_PROTOCOL_VERSION_2"
  ], 
  "id": "ALBProxyProtocolVersion", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ProxyProtocolVersion type", 
  "type": "string"
}

ALBQueryMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer QueryMatch object", 
  "id": "ALBQueryMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_criteria": {
      "$ref": "ALBQueryMatchOperation, 
      "description": "Criterion to use for matching the query in HTTP request URI. Enum options - QUERY_MATCH_CONTAINS.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "match_str": {
      "description": "String value(s).", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Match str", 
      "type": "array"
    }, 
    "string_group_paths": {
      "description": "path of the string group(s). It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "String group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBHTTPPolicySet"
          ], 
          "relationshipType": "ALB_HTTPPOLICYSET_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }
  }, 
  "title": "QueryMatch", 
  "type": "object"
}

ALBQueryMatchOperation (type)

{
  "description": "Valid ENUM values for ALBQueryMatchOperation", 
  "enum": [
    "QUERY_MATCH_CONTAINS"
  ], 
  "id": "ALBQueryMatchOperation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "QueryMatchOperation type", 
  "type": "string"
}

ALBRateLimiter (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer RateLimiter object", 
  "id": "ALBRateLimiter", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "burst_sz": {
      "default": 0, 
      "description": "Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000000000, 
      "minimum": 0, 
      "required": false, 
      "title": "Burst sz", 
      "type": "integer"
    }, 
    "count": {
      "default": 1000000000, 
      "description": "Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Default value when not specified in API or module is interpreted by ALB Controller as 1000000000.", 
      "maximum": 1000000000, 
      "minimum": 1, 
      "required": false, 
      "title": "Count", 
      "type": "integer"
    }, 
    "name": {
      "description": "Identifier for Rate Limit. Constructed according to context.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "period": {
      "default": 1, 
      "description": "Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 1000000000, 
      "minimum": 1, 
      "required": false, 
      "title": "Period", 
      "type": "integer"
    }
  }, 
  "title": "RateLimiter", 
  "type": "object"
}

ALBRateLimiterAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer RateLimiterAction object", 
  "id": "ALBRateLimiterAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "file": {
      "$ref": "ALBHTTPLocalFile, 
      "description": "File to be used for HTTP Local response rate limit action.", 
      "required": false, 
      "title": "File"
    }, 
    "redirect": {
      "$ref": "ALBHTTPRedirectAction, 
      "description": "Parameters for HTTP Redirect rate limit action.", 
      "required": false, 
      "title": "Redirect"
    }, 
    "status_code": {
      "$ref": "ALBHTTPLocalResponseStatusCode, 
      "default": "HTTP_LOCAL_RESPONSE_STATUS_CODE_429", 
      "description": "HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. Default value when not specified in API or module is interpreted by ALB Controller as HTTP_LOCAL_RESPONSE_STATUS_CODE_429.", 
      "required": false, 
      "title": "Status code"
    }, 
    "type": {
      "$ref": "ALBRateLimiterActionType, 
      "default": "RL_ACTION_NONE", 
      "description": "Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT. Default value when not specified in API or module is interpreted by ALB Controller as RL_ACTION_NONE.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "RateLimiterAction", 
  "type": "object"
}

ALBRateLimiterActionType (type)

{
  "description": "Valid ENUM values for ALBRateLimiterActionType", 
  "enum": [
    "RL_ACTION_NONE", 
    "RL_ACTION_DROP_CONN", 
    "RL_ACTION_RESET_CONN", 
    "RL_ACTION_CLOSE_CONN", 
    "RL_ACTION_LOCAL_RSP", 
    "RL_ACTION_REDIRECT"
  ], 
  "id": "ALBRateLimiterActionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "RateLimiterActionType type", 
  "type": "string"
}

ALBRateLimiterProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer RateLimiterProfile object", 
  "id": "ALBRateLimiterProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip_connections_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all connections made from any single client IP address to the Virtual Service.", 
      "required": false, 
      "title": "Client ip connections rate limit"
    }, 
    "client_ip_failed_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all requests from a client for a specified period of time once the count of failed requests from that client crosses a threshold for that period. Clients are tracked based on their IP address. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests.", 
      "required": false, 
      "title": "Client ip failed requests rate limit"
    }, 
    "client_ip_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all HTTP requests from any single client IP address to all URLs of the Virtual Service.", 
      "required": false, 
      "title": "Client ip requests rate limit"
    }, 
    "client_ip_scanners_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Automatically track clients and classify them into 3 groups - Good, Bad, Unknown. Clients are tracked based on their IP Address. Clients are added to the Good group when the Avi Scan Detection system builds history of requests from them that complete successfully. Clients are added to Unknown group when there is insufficient history about them. Requests from such clients are rate limited to the rate specified in the RateProfile. Finally, Clients with history of failed requests are added to Bad group and their requests are rate limited with stricter thresholds than the Unknown Clients group. The Avi Scan Detection system automatically tunes itself so that the Good, Bad, and Unknown client IPs group membership changes dynamically with the changes in traffic patterns through the ADC.", 
      "required": false, 
      "title": "Client ip scanners requests rate limit"
    }, 
    "client_ip_to_uri_failed_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all requests from a client to a URI for a specified period of time once the count of failed requests from that client to the URI crosses a threshold for that period. Clients are tracked based on their IP address. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests.", 
      "required": false, 
      "title": "Client ip to uri failed requests rate limit"
    }, 
    "client_ip_to_uri_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all HTTP requests from any single client IP address to any single URL.", 
      "required": false, 
      "title": "Client ip to uri requests rate limit"
    }, 
    "custom_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all HTTP requests that map to any custom string.", 
      "required": false, 
      "title": "Custom requests rate limit"
    }, 
    "http_header_rate_limits": {
      "description": "Rate Limit all HTTP requests from all client IP addresses that contain any single HTTP header value.", 
      "items": {
        "$ref": "ALBRateProfile
      }, 
      "required": false, 
      "title": "Http header rate limits", 
      "type": "array"
    }, 
    "uri_failed_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all requests to a URI for a specified period of time once the count of failed requests to that URI crosses a threshold for that period. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests.", 
      "required": false, 
      "title": "Uri failed requests rate limit"
    }, 
    "uri_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate Limit all HTTP requests from all client IP addresses to any single URL.", 
      "required": false, 
      "title": "Uri requests rate limit"
    }, 
    "uri_scanners_requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Automatically track URIs and classify them into 3 groups - Good, Bad, Unknown. URIs are added to the Good group when the Avi Scan Detection system builds history of requests to URIs that complete successfully. URIs are added to Unknown group when there is insufficient history about them. Requests for such URIs are rate limited to the rate specified in the RateProfile. Finally, URIs with history of failed requests are added to Bad group and requests to them are rate limited with stricter thresholds than the Unknown URIs group. The Avi Scan Detection system automatically tunes itself so that the Good, Bad, and Unknown URIs group membership changes dynamically with the changes in traffic patterns through the ADC.", 
      "required": false, 
      "title": "Uri scanners requests rate limit"
    }
  }, 
  "title": "RateLimiterProfile", 
  "type": "object"
}

ALBRateProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer RateProfile object", 
  "id": "ALBRateProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBRateLimiterAction, 
      "description": "Action to perform upon rate limiting.", 
      "required": true, 
      "title": "Action"
    }, 
    "explicit_tracking": {
      "default": false, 
      "description": "Explicitly tracks an attacker across rate periods. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Explicit tracking", 
      "type": "boolean"
    }, 
    "fine_grain": {
      "default": false, 
      "description": "Enable fine granularity. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Fine grain", 
      "type": "boolean"
    }, 
    "http_cookie": {
      "description": "HTTP cookie name.", 
      "required": false, 
      "title": "Http cookie", 
      "type": "string"
    }, 
    "http_header": {
      "description": "HTTP header name.", 
      "required": false, 
      "title": "Http header", 
      "type": "string"
    }, 
    "rate_limiter": {
      "$ref": "ALBRateLimiter, 
      "description": "The rate limiter configuration for this rate profile.", 
      "required": false, 
      "title": "Rate limiter"
    }
  }, 
  "title": "RateProfile", 
  "type": "object"
}

ALBReplaceStringType (type)

{
  "description": "Valid ENUM values for ALBReplaceStringType", 
  "enum": [
    "DATASCRIPT_VAR", 
    "HTTP_HEADER_VAR", 
    "LITERAL_STRING"
  ], 
  "id": "ALBReplaceStringType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "ReplaceStringType type", 
  "type": "string"
}

ALBReplaceStringVar (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ReplaceStringVar object", 
  "id": "ALBReplaceStringVar", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "type": {
      "$ref": "ALBReplaceStringType, 
      "description": "Type of replacement string - can be a variable exposed from datascript, value of an HTTP header or a custom user-input literal string. Enum options - DATASCRIPT_VAR, HTTP_HEADER_VAR, LITERAL_STRING.", 
      "required": false, 
      "title": "Type"
    }, 
    "val": {
      "description": "Value of the replacement string - name of variable exposed from datascript, name of the HTTP header or a custom user-input literal string.", 
      "required": false, 
      "title": "Val", 
      "type": "string"
    }
  }, 
  "title": "ReplaceStringVar", 
  "type": "object"
}

ALBResponseMatchTarget (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ResponseMatchTarget object", 
  "id": "ALBResponseMatchTarget", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Configure client ip addresses.", 
      "required": false, 
      "title": "Client ip"
    }, 
    "cookie": {
      "$ref": "ALBCookieMatch, 
      "description": "Configure HTTP cookie(s).", 
      "required": false, 
      "title": "Cookie"
    }, 
    "hdrs": {
      "description": "Configure HTTP headers.", 
      "items": {
        "$ref": "ALBHdrMatch
      }, 
      "required": false, 
      "title": "Hdrs", 
      "type": "array"
    }, 
    "host_hdr": {
      "$ref": "ALBHostHdrMatch, 
      "description": "Configure the host header.", 
      "required": false, 
      "title": "Host hdr"
    }, 
    "loc_hdr": {
      "$ref": "ALBLocationHdrMatch, 
      "description": "Configure the location header.", 
      "required": false, 
      "title": "Loc hdr"
    }, 
    "method": {
      "$ref": "ALBMethodMatch, 
      "description": "Configure HTTP methods.", 
      "required": false, 
      "title": "Method"
    }, 
    "path": {
      "$ref": "ALBPathMatch, 
      "description": "Configure request paths.", 
      "required": false, 
      "title": "Path"
    }, 
    "protocol": {
      "$ref": "ALBProtocolMatch, 
      "description": "Configure the type of HTTP protocol.", 
      "required": false, 
      "title": "Protocol"
    }, 
    "query": {
      "$ref": "ALBQueryMatch, 
      "description": "Configure request query.", 
      "required": false, 
      "title": "Query"
    }, 
    "rsp_hdrs": {
      "description": "Configure the HTTP headers in response.", 
      "items": {
        "$ref": "ALBHdrMatch
      }, 
      "required": false, 
      "title": "Rsp hdrs", 
      "type": "array"
    }, 
    "status": {
      "$ref": "ALBHTTPStatusMatch, 
      "description": "Configure the HTTP status code(s).", 
      "required": false, 
      "title": "Status"
    }, 
    "version": {
      "$ref": "ALBHTTPVersionMatch, 
      "description": "Configure versions of the HTTP protocol.", 
      "required": false, 
      "title": "Version"
    }, 
    "vs_port": {
      "$ref": "ALBPortMatch, 
      "description": "Configure virtual service ports.", 
      "required": false, 
      "title": "Vs port"
    }
  }, 
  "title": "ResponseMatchTarget", 
  "type": "object"
}

ALBRoleFilterMatchLabel (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer RoleFilterMatchLabel object", 
  "id": "ALBRoleFilterMatchLabel", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "key": {
      "description": "Key for filter match.", 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "values": {
      "description": "Values for filter match. Multiple values will be evaluated as OR. Example  key = value1 OR key = value2. Behavior for match is key = (STAR) if this field is empty.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Values", 
      "type": "array"
    }
  }, 
  "title": "RoleFilterMatchLabel", 
  "type": "object"
}

ALBSAMLSPConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SAMLSPConfig object", 
  "id": "ALBSAMLSPConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "cookie_name": {
      "description": "HTTP cookie name for authenticated session.", 
      "required": false, 
      "title": "Cookie name", 
      "type": "string"
    }, 
    "cookie_timeout": {
      "default": 60, 
      "description": "Cookie timeout in minutes. Allowed values are 1-1440. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 60.", 
      "maximum": 1440, 
      "minimum": 1, 
      "required": false, 
      "title": "Cookie timeout", 
      "type": "integer"
    }, 
    "entity_id": {
      "description": "Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this.", 
      "required": true, 
      "title": "Entity id", 
      "type": "string"
    }, 
    "key": {
      "description": "Key to generate the cookie.", 
      "items": {
        "$ref": "ALBHttpCookiePersistenceKey
      }, 
      "required": false, 
      "title": "Key", 
      "type": "array"
    }, 
    "signing_ssl_key_and_certificate_path": {
      "description": "SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate.", 
      "required": false, 
      "title": "Signing ssl key and certificate path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SSLKEYANDCERTIFICATE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLKeyAndCertificate"
          ]
        }
      ]
    }, 
    "single_signon_url": {
      "description": "SAML Single Signon URL to be programmed on the IDP.", 
      "required": true, 
      "title": "Single signon url", 
      "type": "string"
    }, 
    "sp_metadata": {
      "description": "SAML SP metadata for this application.", 
      "required": false, 
      "title": "Sp metadata", 
      "type": "string"
    }, 
    "use_idp_session_timeout": {
      "description": "By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response.", 
      "required": false, 
      "title": "Use idp session timeout", 
      "type": "boolean"
    }
  }, 
  "title": "SAMLSPConfig", 
  "type": "object"
}

ALBSSLCertificate (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLCertificate object", 
  "id": "ALBSSLCertificate", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "certificate": {
      "description": "certificate of SSLCertificate.", 
      "required": false, 
      "title": "Certificate", 
      "type": "string"
    }, 
    "certificate_signing_request": {
      "description": "certificate_signing_request of SSLCertificate.", 
      "required": false, 
      "title": "Certificate signing request", 
      "type": "string"
    }, 
    "chain_verified": {
      "description": "Placeholder for description of property chain_verified of obj type SSLCertificate field type str  type boolean.", 
      "required": false, 
      "title": "Chain verified", 
      "type": "boolean"
    }, 
    "days_until_expire": {
      "default": 365, 
      "description": "Number of days_until_expire. Default value when not specified in API or module is interpreted by ALB Controller as 365.", 
      "minimum": 1, 
      "required": false, 
      "title": "Days until expire", 
      "type": "integer"
    }, 
    "expiry_status": {
      "$ref": "ALBSSLCertificateExpiryStatus, 
      "default": "SSL_CERTIFICATE_GOOD", 
      "description": "Enum options - SSL_CERTIFICATE_GOOD, SSL_CERTIFICATE_EXPIRY_WARNING, SSL_CERTIFICATE_EXPIRED. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CERTIFICATE_GOOD.", 
      "required": false, 
      "title": "Expiry status"
    }, 
    "fingerprint": {
      "description": "fingerprint of SSLCertificate.", 
      "required": false, 
      "title": "Fingerprint", 
      "type": "string"
    }, 
    "issuer": {
      "$ref": "ALBSSLCertificateDescription, 
      "description": "Placeholder for description of property issuer of obj type SSLCertificate field type str  type ref.", 
      "required": false, 
      "title": "Issuer"
    }, 
    "key_params": {
      "$ref": "ALBSSLKeyParams, 
      "description": "Placeholder for description of property key_params of obj type SSLCertificate field type str  type ref.", 
      "required": false, 
      "title": "Key params"
    }, 
    "not_after": {
      "description": "not_after of SSLCertificate.", 
      "required": false, 
      "title": "Not after", 
      "type": "string"
    }, 
    "not_before": {
      "description": "not_before of SSLCertificate.", 
      "required": false, 
      "title": "Not before", 
      "type": "string"
    }, 
    "public_key": {
      "description": "public_key of SSLCertificate.", 
      "required": false, 
      "title": "Public key", 
      "type": "string"
    }, 
    "self_signed": {
      "description": "Placeholder for description of property self_signed of obj type SSLCertificate field type str  type boolean.", 
      "required": false, 
      "title": "Self signed", 
      "type": "boolean"
    }, 
    "serial_number": {
      "description": "serial_number of SSLCertificate.", 
      "required": false, 
      "title": "Serial number", 
      "type": "string"
    }, 
    "signature": {
      "description": "signature of SSLCertificate.", 
      "required": false, 
      "title": "Signature", 
      "type": "string"
    }, 
    "signature_algorithm": {
      "description": "signature_algorithm of SSLCertificate.", 
      "required": false, 
      "title": "Signature algorithm", 
      "type": "string"
    }, 
    "subject": {
      "$ref": "ALBSSLCertificateDescription, 
      "description": "Placeholder for description of property subject of obj type SSLCertificate field type str  type ref.", 
      "required": false, 
      "title": "Subject"
    }, 
    "subject_alt_names": {
      "description": "subjectAltName that provides additional subject identities.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Subject alt names", 
      "type": "array"
    }, 
    "text": {
      "description": "text of SSLCertificate.", 
      "required": false, 
      "title": "Text", 
      "type": "string"
    }, 
    "version": {
      "description": "version of SSLCertificate.", 
      "required": false, 
      "title": "Version", 
      "type": "string"
    }
  }, 
  "title": "SSLCertificate", 
  "type": "object"
}

ALBSSLCertificateDescription (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLCertificateDescription object", 
  "id": "ALBSSLCertificateDescription", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "common_name": {
      "description": "common_name of SSLCertificateDescription.", 
      "required": false, 
      "title": "Common name", 
      "type": "string"
    }, 
    "country": {
      "description": "country of SSLCertificateDescription.", 
      "required": false, 
      "title": "Country", 
      "type": "string"
    }, 
    "distinguished_name": {
      "description": "distinguished_name of SSLCertificateDescription.", 
      "required": false, 
      "title": "Distinguished name", 
      "type": "string"
    }, 
    "email_address": {
      "description": "email_address of SSLCertificateDescription.", 
      "required": false, 
      "title": "Email address", 
      "type": "string"
    }, 
    "locality": {
      "description": "locality of SSLCertificateDescription.", 
      "required": false, 
      "title": "Locality", 
      "type": "string"
    }, 
    "organization": {
      "description": "organization of SSLCertificateDescription.", 
      "required": false, 
      "title": "Organization", 
      "type": "string"
    }, 
    "organization_unit": {
      "description": "organization_unit of SSLCertificateDescription.", 
      "required": false, 
      "title": "Organization unit", 
      "type": "string"
    }, 
    "state": {
      "description": "state of SSLCertificateDescription.", 
      "required": false, 
      "title": "State", 
      "type": "string"
    }
  }, 
  "title": "SSLCertificateDescription", 
  "type": "object"
}

ALBSSLCertificateExpiryStatus (type)

{
  "description": "Valid ENUM values for ALBSSLCertificateExpiryStatus", 
  "enum": [
    "SSL_CERTIFICATE_GOOD", 
    "SSL_CERTIFICATE_EXPIRY_WARNING", 
    "SSL_CERTIFICATE_EXPIRED"
  ], 
  "id": "ALBSSLCertificateExpiryStatus", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLCertificateExpiryStatus type", 
  "type": "string"
}

ALBSSLCertificateStatus (type)

{
  "description": "Valid ENUM values for ALBSSLCertificateStatus", 
  "enum": [
    "SSL_CERTIFICATE_FINISHED", 
    "SSL_CERTIFICATE_PENDING"
  ], 
  "id": "ALBSSLCertificateStatus", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLCertificateStatus type", 
  "type": "string"
}

ALBSSLCertificateType (type)

{
  "description": "Valid ENUM values for ALBSSLCertificateType", 
  "enum": [
    "SSL_CERTIFICATE_TYPE_VIRTUALSERVICE", 
    "SSL_CERTIFICATE_TYPE_SYSTEM", 
    "SSL_CERTIFICATE_TYPE_CA"
  ], 
  "id": "ALBSSLCertificateType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLCertificateType type", 
  "type": "string"
}

ALBSSLClientCertificateAction (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLClientCertificateAction object", 
  "id": "ALBSSLClientCertificateAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "close_connection": {
      "default": false, 
      "description": "Placeholder for description of property close_connection of obj type SSLClientCertificateAction field type str  type boolean. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Close connection", 
      "type": "boolean"
    }, 
    "headers": {
      "description": "Placeholder for description of property headers of obj type SSLClientCertificateAction field type str  type array.", 
      "items": {
        "$ref": "ALBSSLClientRequestHeader
      }, 
      "required": false, 
      "title": "Headers", 
      "type": "array"
    }
  }, 
  "title": "SSLClientCertificateAction", 
  "type": "object"
}

ALBSSLClientCertificateMode (type)

{
  "description": "Valid ENUM values for ALBSSLClientCertificateMode", 
  "enum": [
    "SSL_CLIENT_CERTIFICATE_NONE", 
    "SSL_CLIENT_CERTIFICATE_REQUEST", 
    "SSL_CLIENT_CERTIFICATE_REQUIRE"
  ], 
  "id": "ALBSSLClientCertificateMode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLClientCertificateMode type", 
  "type": "string"
}

ALBSSLClientRequestHeader (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLClientRequestHeader object", 
  "id": "ALBSSLClientRequestHeader", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "request_header": {
      "description": "If this header exists, reset the connection. If the ssl variable is specified, add a header with this value.", 
      "required": false, 
      "title": "Request header", 
      "type": "string"
    }, 
    "request_header_value": {
      "$ref": "ALBHTTPPolicyVar, 
      "description": "Set the request header with the value as indicated by this SSL variable. Eg. send the whole certificate in PEM format. Enum options - HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_REQUEST_ID, HTTP_POLICY_VAR_SSL_CLIENT_VERSION, HTTP_POLICY_VAR_SSL_CLIENT_SIGALG, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDBEFORE, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDAFTER.", 
      "required": false, 
      "title": "Request header value"
    }
  }, 
  "title": "SSLClientRequestHeader", 
  "type": "object"
}

ALBSSLFormat (type)

{
  "description": "Valid ENUM values for ALBSSLFormat", 
  "enum": [
    "SSL_PEM", 
    "SSL_PKCS12"
  ], 
  "id": "ALBSSLFormat", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLFormat type", 
  "type": "string"
}

ALBSSLKeyAlgorithm (type)

{
  "description": "Valid ENUM values for ALBSSLKeyAlgorithm", 
  "enum": [
    "SSL_KEY_ALGORITHM_RSA", 
    "SSL_KEY_ALGORITHM_EC"
  ], 
  "id": "ALBSSLKeyAlgorithm", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLKeyAlgorithm type", 
  "type": "string"
}

ALBSSLKeyAndCertificate (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLKeyAndCertificate object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBSSLKeyAndCertificate", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "ca_certs": {
      "description": "CA certificates in certificate chain.", 
      "items": {
        "$ref": "ALBCertificateAuthority
      }, 
      "required": false, 
      "title": "Ca certs", 
      "type": "array"
    }, 
    "certificate": {
      "$ref": "ALBSSLCertificate, 
      "description": "Placeholder for description of property certificate of obj type SSLKeyAndCertificate field type str  type ref.", 
      "required": true, 
      "title": "Certificate"
    }, 
    "certificate_base64": {
      "default": false, 
      "description": "States if the certificate is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Certificate base64", 
      "type": "boolean"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "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"
    }, 
    "dynamic_params": {
      "description": "Dynamic parameters needed for certificate management profile.", 
      "items": {
        "$ref": "ALBCustomParams
      }, 
      "required": false, 
      "title": "Dynamic params", 
      "type": "array"
    }, 
    "enable_ocsp_stapling": {
      "default": false, 
      "description": "Enables OCSP Stapling. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable ocsp stapling", 
      "type": "boolean"
    }, 
    "enckey_base64": {
      "description": "Encrypted private key corresponding to the private key (e.g. those generated by an HSM such as Thales nShield).", 
      "required": false, 
      "title": "Enckey base64", 
      "type": "string"
    }, 
    "enckey_name": {
      "description": "Name of the encrypted private key (e.g. those generated by an HSM such as Thales nShield).", 
      "required": false, 
      "title": "Enckey name", 
      "type": "string"
    }, 
    "format": {
      "$ref": "ALBSSLFormat, 
      "default": "SSL_PEM", 
      "description": "Format of the Key/Certificate file. Enum options - SSL_PEM, SSL_PKCS12. Default value when not specified in API or module is interpreted by ALB Controller as SSL_PEM.", 
      "required": false, 
      "title": "Format"
    }, 
    "hardwaresecuritymodulegroup_path": {
      "description": "It is a reference to an object of type HardwareSecurityModuleGroup.", 
      "required": false, 
      "title": "Hardwaresecuritymodulegroup path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBSSLKeyAndCertificate"
          ], 
          "relationshipType": "ALB_SSLKEYANDCERTIFICATE_ALB_HARDWARESECURITYMODULEGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBHardwareSecurityModuleGroup"
          ]
        }
      ]
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key": {
      "description": "Private key.", 
      "required": false, 
      "sensitive": true, 
      "title": "Key", 
      "type": "secure_string"
    }, 
    "key_base64": {
      "default": false, 
      "description": "States if the private key is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Key base64", 
      "type": "boolean"
    }, 
    "key_params": {
      "$ref": "ALBSSLKeyParams, 
      "description": "Placeholder for description of property key_params of obj type SSLKeyAndCertificate field type str  type ref.", 
      "required": false, 
      "title": "Key params"
    }, 
    "key_passphrase": {
      "description": "Passphrase used to encrypt the private key.", 
      "required": false, 
      "sensitive": true, 
      "title": "Key passphrase", 
      "type": "secure_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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "ocsp_config": {
      "$ref": "ALBOCSPConfig, 
      "description": "Configuration related to OCSP. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Ocsp config"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "ALBSSLCertificateStatus, 
      "default": "SSL_CERTIFICATE_FINISHED", 
      "description": "Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CERTIFICATE_FINISHED.", 
      "required": false, 
      "title": "Status"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBSSLCertificateType, 
      "description": "Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA.", 
      "required": false, 
      "title": "Type"
    }, 
    "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": "SSLKeyAndCertificate", 
  "type": "object"
}

ALBSSLKeyAndCertificateApiResponse (type)

{
  "additionalProperties": false, 
  "description": "SSLKeyAndCertificateApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBSSLKeyAndCertificateApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of SSLKeyAndCertificate", 
      "items": {
        "$ref": "ALBSSLKeyAndCertificate
      }, 
      "required": false, 
      "title": "Array of SSLKeyAndCertificate", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SSLKeyAndCertificateApiResponse", 
  "type": "object"
}

ALBSSLKeyECCurve (type)

{
  "description": "Valid ENUM values for ALBSSLKeyECCurve", 
  "enum": [
    "SSL_KEY_EC_CURVE_SECP256R1", 
    "SSL_KEY_EC_CURVE_SECP384R1", 
    "SSL_KEY_EC_CURVE_SECP521R1"
  ], 
  "id": "ALBSSLKeyECCurve", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLKeyECCurve type", 
  "type": "string"
}

ALBSSLKeyECParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLKeyECParams object", 
  "id": "ALBSSLKeyECParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "curve": {
      "$ref": "ALBSSLKeyECCurve, 
      "default": "SSL_KEY_EC_CURVE_SECP256R1", 
      "description": "Enum options - SSL_KEY_EC_CURVE_SECP256R1, SSL_KEY_EC_CURVE_SECP384R1, SSL_KEY_EC_CURVE_SECP521R1. Default value when not specified in API or module is interpreted by ALB Controller as SSL_KEY_EC_CURVE_SECP256R1.", 
      "required": false, 
      "title": "Curve"
    }
  }, 
  "title": "SSLKeyECParams", 
  "type": "object"
}

ALBSSLKeyParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLKeyParams object", 
  "id": "ALBSSLKeyParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "algorithm": {
      "$ref": "ALBSSLKeyAlgorithm, 
      "default": "SSL_KEY_ALGORITHM_RSA", 
      "description": "Enum options - SSL_KEY_ALGORITHM_RSA, SSL_KEY_ALGORITHM_EC. Default value when not specified in API or module is interpreted by ALB Controller as SSL_KEY_ALGORITHM_RSA.", 
      "required": true, 
      "title": "Algorithm"
    }, 
    "ec_params": {
      "$ref": "ALBSSLKeyECParams, 
      "description": "Placeholder for description of property ec_params of obj type SSLKeyParams field type str  type ref.", 
      "required": false, 
      "title": "Ec params"
    }, 
    "rsa_params": {
      "$ref": "ALBSSLKeyRSAParams, 
      "description": "Placeholder for description of property rsa_params of obj type SSLKeyParams field type str  type ref.", 
      "required": false, 
      "title": "Rsa params"
    }
  }, 
  "title": "SSLKeyParams", 
  "type": "object"
}

ALBSSLKeyRSAParams (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLKeyRSAParams object", 
  "id": "ALBSSLKeyRSAParams", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "exponent": {
      "default": 65537, 
      "description": "Number of exponent. Default value when not specified in API or module is interpreted by ALB Controller as 65537.", 
      "required": false, 
      "title": "Exponent", 
      "type": "integer"
    }, 
    "key_size": {
      "$ref": "ALBSSLRSAKeySize, 
      "default": "SSL_KEY_2048_BITS", 
      "description": "Enum options - SSL_KEY_1024_BITS, SSL_KEY_2048_BITS, SSL_KEY_3072_BITS, SSL_KEY_4096_BITS. Default value when not specified in API or module is interpreted by ALB Controller as SSL_KEY_2048_BITS.", 
      "required": false, 
      "title": "Key size"
    }
  }, 
  "title": "SSLKeyRSAParams", 
  "type": "object"
}

ALBSSLProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBSSLProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "accepted_ciphers": {
      "default": "AES:3DES:RC4", 
      "description": "Ciphers suites represented as defined by https //www.openssl.org/docs/apps/ciphers.html. Default value when not specified in API or module is interpreted by ALB Controller as AES:3DES:RC4.", 
      "required": false, 
      "title": "Accepted ciphers", 
      "type": "string"
    }, 
    "accepted_versions": {
      "description": "Set of versions accepted by the server. Minimum of 1 items required.", 
      "items": {
        "$ref": "ALBSSLVersion
      }, 
      "required": true, 
      "title": "Accepted versions", 
      "type": "array"
    }, 
    "avi_tags": {
      "description": "Placeholder for description of property tags of obj type SSLProfile field type str  type array.", 
      "items": {
        "$ref": "ALBTag
      }, 
      "required": false, 
      "title": "Avi tags", 
      "type": "array"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cipher_enums": {
      "description": "Enum options - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, 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_256_GCM_SHA384, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_AES_256_GCM_SHA384... Allowed in Basic(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,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_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA) edition, Essentials(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,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_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA) edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBAcceptedCipherEnums
      }, 
      "required": false, 
      "title": "Cipher enums", 
      "type": "array"
    }, 
    "ciphersuites": {
      "default": "TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256", 
      "description": "TLS 1.3 Ciphers suites represented as defined by U(https //www.openssl.org/docs/manmaster/man1/ciphers.html). Allowed in Basic edition, Essentials edition, Enterprise edition. Special default for Basic edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Essentials edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Enterprise is TLS_AES_256_GCM_SHA384-TLS_CHACHA20_POLY1305_SHA256-TLS_AES_128_GCM_SHA256. Default value when not specified in API or module is interpreted by ALB Controller as TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256.", 
      "required": false, 
      "title": "Ciphersuites", 
      "type": "string"
    }, 
    "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"
    }, 
    "enable_early_data": {
      "default": false, 
      "description": "Enable early data processing for TLS1.3 connections. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable early data", 
      "type": "boolean"
    }, 
    "enable_ssl_session_reuse": {
      "default": true, 
      "description": "Enable SSL session re-use. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable ssl session reuse", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "prefer_client_cipher_ordering": {
      "default": false, 
      "description": "Prefer the SSL cipher ordering presented by the client during the SSL handshake over the one specified in the SSL Profile. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Prefer client cipher ordering", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "send_close_notify": {
      "default": true, 
      "description": "Send 'close notify' alert message for a clean shutdown of the SSL connection. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Send close notify", 
      "type": "boolean"
    }, 
    "ssl_rating": {
      "$ref": "ALBSSLRating, 
      "description": "Placeholder for description of property ssl_rating of obj type SSLProfile field type str  type ref.", 
      "readonly": true, 
      "required": false, 
      "title": "Ssl rating"
    }, 
    "ssl_session_timeout": {
      "default": 86400, 
      "description": "The amount of time in seconds before an SSL session expires. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 86400.", 
      "required": false, 
      "title": "Ssl session timeout", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBSSLProfileType, 
      "default": "SSL_PROFILE_TYPE_APPLICATION", 
      "description": "SSL Profile Type. Enum options - SSL_PROFILE_TYPE_APPLICATION, SSL_PROFILE_TYPE_SYSTEM. Default value when not specified in API or module is interpreted by ALB Controller as SSL_PROFILE_TYPE_APPLICATION.", 
      "required": false, 
      "title": "Type"
    }, 
    "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": "SSLProfile", 
  "type": "object"
}

ALBSSLProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "SSLProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBSSLProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of SSLProfile", 
      "items": {
        "$ref": "ALBSSLProfile
      }, 
      "required": false, 
      "title": "Array of SSLProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SSLProfileApiResponse", 
  "type": "object"
}

ALBSSLProfileSelector (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLProfileSelector object", 
  "id": "ALBSSLProfileSelector", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_ip_list": {
      "$ref": "ALBIpAddrMatch, 
      "description": "Configure client IP address groups.", 
      "required": true, 
      "title": "Client ip list"
    }, 
    "ssl_profile_path": {
      "description": "SSL profile for the client IP addresses listed. It is a reference to an object of type SSLProfile.", 
      "required": true, 
      "title": "Ssl profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SSLPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLProfile"
          ]
        }
      ]
    }
  }, 
  "title": "SSLProfileSelector", 
  "type": "object"
}

ALBSSLProfileType (type)

{
  "description": "Valid ENUM values for ALBSSLProfileType", 
  "enum": [
    "SSL_PROFILE_TYPE_APPLICATION", 
    "SSL_PROFILE_TYPE_SYSTEM"
  ], 
  "id": "ALBSSLProfileType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLProfileType type", 
  "type": "string"
}

ALBSSLRSAKeySize (type)

{
  "description": "Valid ENUM values for ALBSSLRSAKeySize", 
  "enum": [
    "SSL_KEY_1024_BITS", 
    "SSL_KEY_2048_BITS", 
    "SSL_KEY_3072_BITS", 
    "SSL_KEY_4096_BITS"
  ], 
  "id": "ALBSSLRSAKeySize", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLRSAKeySize type", 
  "type": "string"
}

ALBSSLRating (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLRating object", 
  "id": "ALBSSLRating", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "compatibility_rating": {
      "$ref": "ALBSSLScore, 
      "description": "Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT.", 
      "required": false, 
      "title": "Compatibility rating"
    }, 
    "performance_rating": {
      "$ref": "ALBSSLScore, 
      "description": "Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT.", 
      "required": false, 
      "title": "Performance rating"
    }, 
    "security_score": {
      "description": "security_score of SSLRating.", 
      "required": false, 
      "title": "Security score", 
      "type": "string"
    }
  }, 
  "title": "SSLRating", 
  "type": "object"
}

ALBSSLScore (type)

{
  "description": "Valid ENUM values for ALBSSLScore", 
  "enum": [
    "SSL_SCORE_NOT_SECURE", 
    "SSL_SCORE_VERY_BAD", 
    "SSL_SCORE_BAD", 
    "SSL_SCORE_AVERAGE", 
    "SSL_SCORE_GOOD", 
    "SSL_SCORE_EXCELLENT"
  ], 
  "id": "ALBSSLScore", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLScore type", 
  "type": "string"
}

ALBSSLVersion (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSLVersion object", 
  "id": "ALBSSLVersion", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "type": {
      "$ref": "ALBSSLVersionType, 
      "default": "SSL_VERSION_TLS1_1", 
      "description": "Enum options - SSL_VERSION_SSLV3, SSL_VERSION_TLS1, SSL_VERSION_TLS1_1, SSL_VERSION_TLS1_2, SSL_VERSION_TLS1_3. Allowed in Basic(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2) edition, Essentials(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as SSL_VERSION_TLS1_1.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "SSLVersion", 
  "type": "object"
}

ALBSSLVersionType (type)

{
  "description": "Valid ENUM values for ALBSSLVersionType", 
  "enum": [
    "SSL_VERSION_SSLV3", 
    "SSL_VERSION_TLS1", 
    "SSL_VERSION_TLS1_1", 
    "SSL_VERSION_TLS1_2", 
    "SSL_VERSION_TLS1_3"
  ], 
  "id": "ALBSSLVersionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSLVersionType type", 
  "type": "string"
}

ALBSSOPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SSOPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBSSOPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "authentication_policy": {
      "$ref": "ALBAuthenticationPolicy, 
      "description": "Authentication Policy Settings.", 
      "required": true, 
      "title": "Authentication policy"
    }, 
    "authorization_policy": {
      "$ref": "ALBAuthorizationPolicy, 
      "description": "Authorization Policy Settings.", 
      "required": false, 
      "title": "Authorization policy"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBSSOPolicyType, 
      "default": "SSO_TYPE_SAML", 
      "description": "SSO Policy Type. Enum options - SSO_TYPE_SAML, SSO_TYPE_PINGACCESS, SSO_TYPE_JWT. Default value when not specified in API or module is interpreted by ALB Controller as SSO_TYPE_SAML.", 
      "required": false, 
      "title": "Type"
    }, 
    "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": "SSOPolicy", 
  "type": "object"
}

ALBSSOPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "SSOPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBSSOPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of SSOPolicy", 
      "items": {
        "$ref": "ALBSSOPolicy
      }, 
      "required": false, 
      "title": "Array of SSOPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SSOPolicyApiResponse", 
  "type": "object"
}

ALBSSOPolicyType (type)

{
  "description": "Valid ENUM values for ALBSSOPolicyType", 
  "enum": [
    "SSO_TYPE_SAML", 
    "SSO_TYPE_PINGACCESS", 
    "SSO_TYPE_JWT"
  ], 
  "id": "ALBSSOPolicyType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SSOPolicyType type", 
  "type": "string"
}

ALBSamlIdentityProviderSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SamlIdentityProviderSettings object", 
  "id": "ALBSamlIdentityProviderSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "metadata": {
      "description": "SAML IDP metadata.", 
      "required": false, 
      "title": "Metadata", 
      "type": "string"
    }
  }, 
  "title": "SamlIdentityProviderSettings", 
  "type": "object"
}

ALBSamlServiceProviderNode (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SamlServiceProviderNode object", 
  "id": "ALBSamlServiceProviderNode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "entity_id": {
      "description": "Globally unique entityID for this node. Entity ID on the IDP should match this.", 
      "required": false, 
      "title": "Entity id", 
      "type": "string"
    }, 
    "name": {
      "description": "Refers to the Cluster name identifier (Virtual IP or FQDN).", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "signing_ssl_key_and_certificate_path": {
      "description": "Service Engines will use this SSL certificate to sign assertions going to the IdP. It is a reference to an object of type SSLKeyAndCertificate.", 
      "required": false, 
      "title": "Signing ssl key and certificate path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBAuthProfile"
          ], 
          "relationshipType": "ALB_AUTHPROFILE_ALB_SSLKEYANDCERTIFICATE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLKeyAndCertificate"
          ]
        }
      ]
    }, 
    "single_signon_url": {
      "description": "Single Signon URL to be programmed on the IDP.", 
      "required": false, 
      "title": "Single signon url", 
      "type": "string"
    }
  }, 
  "title": "SamlServiceProviderNode", 
  "type": "object"
}

ALBSamlServiceProviderSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SamlServiceProviderSettings object", 
  "id": "ALBSamlServiceProviderSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "fqdn": {
      "description": "FQDN if entity type is DNS_FQDN .", 
      "required": false, 
      "title": "Fqdn", 
      "type": "string"
    }, 
    "org_display_name": {
      "description": "Service Provider Organization Display Name.", 
      "required": false, 
      "title": "Org display name", 
      "type": "string"
    }, 
    "org_name": {
      "description": "Service Provider Organization Name.", 
      "required": false, 
      "title": "Org name", 
      "type": "string"
    }, 
    "org_url": {
      "description": "Service Provider Organization URL.", 
      "required": false, 
      "title": "Org url", 
      "type": "string"
    }, 
    "saml_entity_type": {
      "$ref": "ALBAuthSamlEntityType, 
      "description": "Type of SAML endpoint. Enum options - AUTH_SAML_CLUSTER_VIP, AUTH_SAML_DNS_FQDN, AUTH_SAML_APP_VS.", 
      "required": false, 
      "title": "Saml entity type"
    }, 
    "sp_nodes": {
      "description": "Service Provider node information.", 
      "items": {
        "$ref": "ALBSamlServiceProviderNode
      }, 
      "required": false, 
      "title": "Sp nodes", 
      "type": "array"
    }, 
    "tech_contact_email": {
      "description": "Service Provider technical contact email.", 
      "required": false, 
      "title": "Tech contact email", 
      "type": "string"
    }, 
    "tech_contact_name": {
      "description": "Service Provider technical contact name.", 
      "required": false, 
      "title": "Tech contact name", 
      "type": "string"
    }
  }, 
  "title": "SamlServiceProviderSettings", 
  "type": "object"
}

ALBSamlSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SamlSettings object", 
  "id": "ALBSamlSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "idp": {
      "$ref": "ALBSamlIdentityProviderSettings, 
      "description": "Configure remote Identity provider settings.", 
      "required": false, 
      "title": "Idp"
    }, 
    "sp": {
      "$ref": "ALBSamlServiceProviderSettings, 
      "description": "Configure service provider settings for the Controller.", 
      "required": true, 
      "title": "Sp"
    }
  }, 
  "title": "SamlSettings", 
  "type": "object"
}

ALBSeFlowDist (type)

{
  "description": "Valid ENUM values for ALBSeFlowDist", 
  "enum": [
    "LOAD_AWARE", 
    "CONSISTENT_HASH_SOURCE_IP_ADDRESS", 
    "CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT"
  ], 
  "id": "ALBSeFlowDist", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SeFlowDist type", 
  "type": "string"
}

ALBSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SecurityPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBSecurityPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "dns_attacks": {
      "$ref": "ALBDnsAttacks, 
      "description": "Attacks utilizing the DNS protocol operations.", 
      "required": false, 
      "title": "Dns attacks"
    }, 
    "dns_policy_index": {
      "default": 0, 
      "description": "Index of the dns policy to use for the mitigation rules applied to the dns attacks. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Dns policy index", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "network_security_policy_index": {
      "default": 0, 
      "description": "Index of the network security policy to use for the mitigation rules applied to the attacks. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Network security policy index", 
      "type": "integer"
    }, 
    "oper_mode": {
      "$ref": "ALBOperationMode, 
      "default": "DETECTION", 
      "description": "Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Enum options - DETECTION, MITIGATION. Default value when not specified in API or module is interpreted by ALB Controller as DETECTION.", 
      "required": false, 
      "title": "Oper mode"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "SecurityPolicy", 
  "type": "object"
}

ALBSecurityPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "SecurityPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBSecurityPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of SecurityPolicy", 
      "items": {
        "$ref": "ALBSecurityPolicy
      }, 
      "required": false, 
      "title": "Array of SecurityPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SecurityPolicyApiResponse", 
  "type": "object"
}

ALBSensitiveFieldRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SensitiveFieldRule object", 
  "id": "ALBSensitiveFieldRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "action": {
      "$ref": "ALBLogAction, 
      "default": "LOG_FIELD_REMOVE", 
      "description": "Action for the matched log field, for instance the matched field can be removed or masked off. Enum options - LOG_FIELD_REMOVE, LOG_FIELD_MASKOFF. Default value when not specified in API or module is interpreted by ALB Controller as LOG_FIELD_REMOVE.", 
      "required": false, 
      "title": "Action"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enable rule to match the sensitive fields. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Index of the rule.", 
      "required": false, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBStringMatch, 
      "description": "Criterion to use for matching in the Log. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }
  }, 
  "title": "SensitiveFieldRule", 
  "type": "object"
}

ALBSensitiveLogProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SensitiveLogProfile object", 
  "id": "ALBSensitiveLogProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "header_field_rules": {
      "description": "Match sensitive header fields in HTTP application log.", 
      "items": {
        "$ref": "ALBSensitiveFieldRule
      }, 
      "required": false, 
      "title": "Header field rules", 
      "type": "array"
    }, 
    "uri_query_field_rules": {
      "description": "Match sensitive URI query params in HTTP application log. Query params from the URI are extracted and checked for matching sensitive parameter names. A successful match will mask the parameter values in accordance with this rule action.", 
      "items": {
        "$ref": "ALBSensitiveFieldRule
      }, 
      "required": false, 
      "title": "Uri query field rules", 
      "type": "array"
    }, 
    "waf_field_rules": {
      "description": "Match sensitive WAF log fields in HTTP application log.", 
      "items": {
        "$ref": "ALBSensitiveFieldRule
      }, 
      "required": false, 
      "title": "Waf field rules", 
      "type": "array"
    }
  }, 
  "title": "SensitiveLogProfile", 
  "type": "object"
}

ALBServer (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Server object", 
  "id": "ALBServer", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "autoscaling_group_name": {
      "description": "Name of autoscaling group this server belongs to. Allowed in Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Autoscaling group name", 
      "type": "string"
    }, 
    "availability_zone": {
      "description": "Availability-zone of the server VM.", 
      "required": false, 
      "title": "Availability zone", 
      "type": "string"
    }, 
    "description": {
      "description": "A description of the Server.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "discovered_networks": {
      "description": "(internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.", 
      "items": {
        "$ref": "ALBDiscoveredNetwork
      }, 
      "required": false, 
      "title": "Discovered networks", 
      "type": "array"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "external_orchestration_id": {
      "description": "UID of server in external orchestration systems.", 
      "required": false, 
      "title": "External orchestration id", 
      "type": "string"
    }, 
    "external_uuid": {
      "description": "UUID identifying VM in OpenStack and other external compute.", 
      "required": false, 
      "title": "External uuid", 
      "type": "string"
    }, 
    "hostname": {
      "description": "DNS resolvable name of the server. May be used in place of the IP address.", 
      "required": false, 
      "title": "Hostname", 
      "type": "string"
    }, 
    "ip": {
      "$ref": "ALBIpAddr, 
      "description": "IP Address of the server. Required if there is no resolvable host name.", 
      "required": true, 
      "title": "Ip"
    }, 
    "is_static": {
      "default": false, 
      "description": "If statically learned. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is static", 
      "type": "boolean"
    }, 
    "location": {
      "$ref": "ALBGeoLocation, 
      "description": "(internal-use) Geographic location of the server.Currently only for internal usage. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Location"
    }, 
    "mac_address": {
      "description": "MAC address of server.", 
      "required": false, 
      "title": "Mac address", 
      "type": "string"
    }, 
    "port": {
      "description": "Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }, 
    "prst_hdr_val": {
      "description": "Header value for custom header persistence.", 
      "required": false, 
      "title": "Prst hdr val", 
      "type": "string"
    }, 
    "ratio": {
      "default": 1, 
      "description": "Ratio of selecting eligible servers in the pool. Allowed values are 1-20. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 20, 
      "minimum": 1, 
      "required": false, 
      "title": "Ratio", 
      "type": "integer"
    }, 
    "resolve_server_by_dns": {
      "default": false, 
      "description": "Auto resolve server's IP using DNS name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Resolve server by dns", 
      "type": "boolean"
    }, 
    "rewrite_host_header": {
      "default": false, 
      "description": "Rewrite incoming Host Header to server name. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Rewrite host header", 
      "type": "boolean"
    }, 
    "server_node": {
      "description": "Hostname of the node where the server VM or container resides.", 
      "required": false, 
      "title": "Server node", 
      "type": "string"
    }, 
    "verify_network": {
      "default": false, 
      "description": "Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Verify network", 
      "type": "boolean"
    }
  }, 
  "title": "Server", 
  "type": "object"
}

ALBServerAutoScalePolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ServerAutoScalePolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBServerAutoScalePolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "delay_for_server_garbage_collection": {
      "default": 0, 
      "description": "Delay in minutes after which a down server will be removed from Pool. Value 0 disables this functionality. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Delay for server garbage collection", 
      "type": "integer"
    }, 
    "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"
    }, 
    "intelligent_autoscale": {
      "default": false, 
      "description": "Use Avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Intelligent autoscale", 
      "type": "boolean"
    }, 
    "intelligent_scalein_margin": {
      "default": 40, 
      "description": "Maximum extra capacity as percentage of load used by the intelligent scheme. Scalein is triggered when available capacity is more than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by ALB Controller as 40.", 
      "maximum": 99, 
      "minimum": 1, 
      "required": false, 
      "title": "Intelligent scalein margin", 
      "type": "integer"
    }, 
    "intelligent_scaleout_margin": {
      "default": 20, 
      "description": "Minimum extra capacity as percentage of load used by the intelligent scheme. Scaleout is triggered when available capacity is less than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by ALB Controller as 20.", 
      "maximum": 99, 
      "minimum": 1, 
      "required": false, 
      "title": "Intelligent scaleout margin", 
      "type": "integer"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "max_scalein_adjustment_step": {
      "default": 1, 
      "description": "Maximum number of servers to scalein simultaneously. The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "required": false, 
      "title": "Max scalein adjustment step", 
      "type": "integer"
    }, 
    "max_scaleout_adjustment_step": {
      "default": 1, 
      "description": "Maximum number of servers to scaleout simultaneously. The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "required": false, 
      "title": "Max scaleout adjustment step", 
      "type": "integer"
    }, 
    "max_size": {
      "description": "Maximum number of servers after scaleout. Allowed values are 0-400.", 
      "maximum": 400, 
      "minimum": 0, 
      "required": false, 
      "title": "Max size", 
      "type": "integer"
    }, 
    "min_size": {
      "description": "No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400.", 
      "maximum": 400, 
      "minimum": 0, 
      "required": false, 
      "title": "Min size", 
      "type": "integer"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "scalein_cooldown": {
      "default": 300, 
      "description": "Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300.", 
      "required": false, 
      "title": "Scalein cooldown", 
      "type": "integer"
    }, 
    "scaleout_cooldown": {
      "default": 300, 
      "description": "Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300.", 
      "required": false, 
      "title": "Scaleout cooldown", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "use_predicted_load": {
      "default": false, 
      "description": "Use predicted load rather than current load. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use predicted load", 
      "type": "boolean"
    }
  }, 
  "title": "ServerAutoScalePolicy", 
  "type": "object"
}

ALBServerAutoScalePolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "ServerAutoScalePolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBServerAutoScalePolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of ServerAutoScalePolicy", 
      "items": {
        "$ref": "ALBServerAutoScalePolicy
      }, 
      "required": false, 
      "title": "Array of ServerAutoScalePolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ServerAutoScalePolicyApiResponse", 
  "type": "object"
}

ALBService (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Service object", 
  "id": "ALBService", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable_http2": {
      "default": false, 
      "description": "Enable HTTP2 on this port. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable http2", 
      "type": "boolean"
    }, 
    "enable_ssl": {
      "default": false, 
      "description": "Enable SSL termination and offload for traffic from clients. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable ssl", 
      "type": "boolean"
    }, 
    "override_application_profile_path": {
      "description": "Enable application layer specific features for the this specific service. It is a reference to an object of type ApplicationProfile. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Override application profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_APPLICATIONPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBApplicationProfile"
          ]
        }
      ]
    }, 
    "override_network_profile_path": {
      "description": "Override the network profile for this specific service port. It is a reference to an object of type NetworkProfile.", 
      "required": false, 
      "title": "Override network profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_NETWORKPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBNetworkProfile"
          ]
        }
      ]
    }, 
    "port": {
      "description": "The Virtual Service's port number. Allowed values are 0-65535.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Port", 
      "type": "integer"
    }, 
    "port_range_end": {
      "default": 0, 
      "description": "The end of the Virtual Service's port number range. Allowed values are 1-65535. Special values are 0- 'single port'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port range end", 
      "type": "integer"
    }
  }, 
  "title": "Service", 
  "type": "object"
}

ALBServicePoolSelector (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer ServicePoolSelector object", 
  "id": "ALBServicePoolSelector", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "service_pool_group_path": {
      "description": "It is a reference to an object of type PoolGroup.", 
      "required": false, 
      "title": "Service pool group path", 
      "type": "string"
    }, 
    "service_pool_path": {
      "description": "It is a reference to an object of type Pool.", 
      "required": false, 
      "title": "Service pool path", 
      "type": "string"
    }, 
    "service_port": {
      "description": "Pool based destination port. Allowed values are 1-65535.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": true, 
      "title": "Service port", 
      "type": "integer"
    }, 
    "service_port_range_end": {
      "default": 0, 
      "description": "The end of the Service port number range. Allowed values are 1-65535. Special values are 0- 'single port'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Service port range end", 
      "type": "integer"
    }, 
    "service_protocol": {
      "$ref": "ALBProtocolType, 
      "description": "Destination protocol to match for the pool selection. If not specified, it will match any protocol. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY.", 
      "required": false, 
      "title": "Service protocol"
    }
  }, 
  "title": "ServicePoolSelector", 
  "type": "object"
}

ALBSidebandProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SidebandProfile object", 
  "id": "ALBSidebandProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "ip": {
      "description": "IP Address of the sideband server.", 
      "items": {
        "$ref": "ALBIpAddr
      }, 
      "required": false, 
      "title": "Ip", 
      "type": "array"
    }, 
    "sideband_max_request_body_size": {
      "default": 1024, 
      "description": "Maximum size of the request body that will be sent on the sideband. Allowed values are 0-16384. Unit is BYTES. Default value when not specified in API or module is interpreted by ALB Controller as 1024.", 
      "maximum": 16384, 
      "minimum": 0, 
      "required": false, 
      "title": "Sideband max request body size", 
      "type": "integer"
    }
  }, 
  "title": "SidebandProfile", 
  "type": "object"
}

ALBSipMonTransport (type)

{
  "description": "Valid ENUM values for ALBSipMonTransport", 
  "enum": [
    "SIP_UDP_PROTO", 
    "SIP_TCP_PROTO"
  ], 
  "id": "ALBSipMonTransport", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SipMonTransport type", 
  "type": "string"
}

ALBSipRequestCode (type)

{
  "description": "Valid ENUM values for ALBSipRequestCode", 
  "enum": [
    "SIP_OPTIONS"
  ], 
  "id": "ALBSipRequestCode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "SipRequestCode type", 
  "type": "string"
}

ALBSipServiceApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer SipServiceApplicationProfile object", 
  "id": "ALBSipServiceApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "transaction_timeout": {
      "default": 32, 
      "description": "SIP transaction timeout in seconds. Allowed values are 2-512. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 32.", 
      "maximum": 512, 
      "minimum": 2, 
      "required": false, 
      "title": "Transaction timeout", 
      "type": "integer"
    }
  }, 
  "title": "SipServiceApplicationProfile", 
  "type": "object"
}

ALBStreamingSyslogConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer StreamingSyslogConfig object", 
  "id": "ALBStreamingSyslogConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "facility": {
      "default": 16, 
      "description": "Facility value, as defined in RFC5424, must be between 0 and 23 inclusive. Allowed values are 0-23. Default value when not specified in API or module is interpreted by ALB Controller as 16.", 
      "maximum": 23, 
      "minimum": 0, 
      "required": false, 
      "title": "Facility", 
      "type": "integer"
    }, 
    "filtered_log_severity": {
      "default": 5, 
      "description": "Severity code, as defined in RFC5424, for filtered logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Default value when not specified in API or module is interpreted by ALB Controller as 5.", 
      "maximum": 7, 
      "minimum": 0, 
      "required": false, 
      "title": "Filtered log severity", 
      "type": "integer"
    }, 
    "hostname": {
      "default": "AviVantage", 
      "description": "String to use as the hostname in the syslog messages. This string can contain only printable ASCII characters (hex 21 to hex 7E; no space allowed). Default value when not specified in API or module is interpreted by ALB Controller as AviVantage.", 
      "required": false, 
      "title": "Hostname", 
      "type": "string"
    }, 
    "non_significant_log_severity": {
      "default": 6, 
      "description": "Severity code, as defined in RFC5424, for non-significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Default value when not specified in API or module is interpreted by ALB Controller as 6.", 
      "maximum": 7, 
      "minimum": 0, 
      "required": false, 
      "title": "Non significant log severity", 
      "type": "integer"
    }, 
    "significant_log_severity": {
      "default": 4, 
      "description": "Severity code, as defined in RFC5424, for significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Default value when not specified in API or module is interpreted by ALB Controller as 4.", 
      "maximum": 7, 
      "minimum": 0, 
      "required": false, 
      "title": "Significant log severity", 
      "type": "integer"
    }
  }, 
  "title": "StreamingSyslogConfig", 
  "type": "object"
}

ALBStringGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer StringGroup object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBStringGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "kv": {
      "description": "Configure Key Value in the string group.", 
      "items": {
        "$ref": "ALBKeyValue
      }, 
      "required": false, 
      "title": "Kv", 
      "type": "array"
    }, 
    "longest_match": {
      "default": false, 
      "description": "Enable the longest match, default is the shortest match. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Longest match", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBStringGroupType, 
      "default": "SG_TYPE_STRING", 
      "description": "Type of StringGroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Default value when not specified in API or module is interpreted by ALB Controller as SG_TYPE_STRING.", 
      "required": true, 
      "title": "Type"
    }, 
    "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": "StringGroup", 
  "type": "object"
}

ALBStringGroupApiResponse (type)

{
  "additionalProperties": false, 
  "description": "StringGroupApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBStringGroupApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of StringGroup", 
      "items": {
        "$ref": "ALBStringGroup
      }, 
      "required": false, 
      "title": "Array of StringGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "StringGroupApiResponse", 
  "type": "object"
}

ALBStringGroupType (type)

{
  "description": "Valid ENUM values for ALBStringGroupType", 
  "enum": [
    "SG_TYPE_STRING", 
    "SG_TYPE_KEYVAL"
  ], 
  "id": "ALBStringGroupType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "StringGroupType type", 
  "type": "string"
}

ALBStringMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer StringMatch object", 
  "id": "ALBStringMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_criteria": {
      "$ref": "ALBStringOperation, 
      "description": "Criterion to use for string matching the HTTP request. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition.", 
      "required": true, 
      "title": "Match criteria"
    }, 
    "match_str": {
      "description": "String value(s).", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Match str", 
      "type": "array"
    }, 
    "string_group_paths": {
      "description": "path of the string group(s). It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "String group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBAnalyticsProfile"
          ], 
          "relationshipType": "ALB_ANALYTICSPROFILE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBSSOPolicy"
          ], 
          "relationshipType": "ALB_SSOPOLICY_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }, 
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }
  }, 
  "title": "StringMatch", 
  "type": "object"
}

ALBStringOperation (type)

{
  "description": "Valid ENUM values for ALBStringOperation", 
  "enum": [
    "BEGINS_WITH", 
    "DOES_NOT_BEGIN_WITH", 
    "CONTAINS", 
    "DOES_NOT_CONTAIN", 
    "ENDS_WITH", 
    "DOES_NOT_END_WITH", 
    "EQUALS", 
    "DOES_NOT_EQUAL", 
    "REGEX_MATCH", 
    "REGEX_DOES_NOT_MATCH"
  ], 
  "id": "ALBStringOperation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "StringOperation type", 
  "type": "string"
}

ALBTCPApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer TCPApplicationProfile object", 
  "id": "ALBTCPApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "pki_profile_path": {
      "description": "Select the PKI profile to be associated with the Virtual Service. This profile defines the Certificate Authority and Revocation List. It is a reference to an object of type PKIProfile. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Pki profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBApplicationProfile"
          ], 
          "relationshipType": "ALB_APPLICATIONPROFILE_ALB_PKIPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBPKIProfile"
          ]
        }
      ]
    }, 
    "proxy_protocol_enabled": {
      "default": false, 
      "description": "Enable/Disable the usage of proxy protocol to convey client connection information to the back-end servers. Valid only for L4 application profiles and TCP proxy. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Proxy protocol enabled", 
      "type": "boolean"
    }, 
    "proxy_protocol_version": {
      "$ref": "ALBProxyProtocolVersion, 
      "default": "PROXY_PROTOCOL_VERSION_1", 
      "description": "Version of proxy protocol to be used to convey client connection information to the back-end servers. Enum options - PROXY_PROTOCOL_VERSION_1, PROXY_PROTOCOL_VERSION_2. Allowed in Basic(Allowed values- PROXY_PROTOCOL_VERSION_1) edition, Essentials(Allowed values- PROXY_PROTOCOL_VERSION_1) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as PROXY_PROTOCOL_VERSION_1.", 
      "required": false, 
      "title": "Proxy protocol version"
    }, 
    "ssl_client_certificate_mode": {
      "$ref": "ALBSSLClientCertificateMode, 
      "default": "SSL_CLIENT_CERTIFICATE_NONE", 
      "description": "Specifies whether the client side verification is set to none, request or require. Enum options - SSL_CLIENT_CERTIFICATE_NONE, SSL_CLIENT_CERTIFICATE_REQUEST, SSL_CLIENT_CERTIFICATE_REQUIRE. Allowed in Basic(Allowed values- SSL_CLIENT_CERTIFICATE_NONE) edition, Essentials(Allowed values- SSL_CLIENT_CERTIFICATE_NONE) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CLIENT_CERTIFICATE_NONE.", 
      "required": false, 
      "title": "Ssl client certificate mode"
    }
  }, 
  "title": "TCPApplicationProfile", 
  "type": "object"
}

ALBTCPFastPathProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer TCPFastPathProfile object", 
  "id": "ALBTCPFastPathProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dsr_profile": {
      "$ref": "ALBDsrProfile, 
      "description": "DSR profile information. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Dsr profile"
    }, 
    "enable_syn_protection": {
      "default": false, 
      "description": "When enabled, Avi will complete the 3-way handshake with the client before forwarding any packets to the server. This will protect the server from SYN flood and half open SYN connections. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable syn protection", 
      "type": "boolean"
    }, 
    "session_idle_timeout": {
      "default": 300, 
      "description": "The amount of time (in sec) for which a connection needs to be idle before it is eligible to be deleted. Allowed values are 5-14400. Special values are 0 - 'infinite'. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300.", 
      "maximum": 14400, 
      "minimum": 0, 
      "required": false, 
      "title": "Session idle timeout", 
      "type": "integer"
    }
  }, 
  "title": "TCPFastPathProfile", 
  "type": "object"
}

ALBTCPProxyProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer TCPProxyProfile object", 
  "id": "ALBTCPProxyProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "aggressive_congestion_avoidance": {
      "default": false, 
      "description": "Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Aggressive congestion avoidance", 
      "type": "boolean"
    }, 
    "auto_window_growth": {
      "default": true, 
      "description": "Controls whether the windows are static or supports autogrowth. Maximum that it can grow to is limited to 4MB. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Auto window growth", 
      "type": "boolean"
    }, 
    "automatic": {
      "default": true, 
      "description": "Dynamically pick the relevant parameters for connections. Allowed in Basic(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Automatic", 
      "type": "boolean"
    }, 
    "cc_algo": {
      "$ref": "ALBCongestionAlgo, 
      "default": "CC_ALGO_NEW_RENO", 
      "description": "Controls the congestion control algorithm we use. Enum options - CC_ALGO_NEW_RENO, CC_ALGO_CUBIC, CC_ALGO_HTCP. Default value when not specified in API or module is interpreted by ALB Controller as CC_ALGO_NEW_RENO.", 
      "required": false, 
      "title": "Cc algo"
    }, 
    "congestion_recovery_scaling_factor": {
      "default": 2, 
      "description": "Congestion window scaling factor after recovery. Allowed values are 0-8. Default value when not specified in API or module is interpreted by ALB Controller as 2.", 
      "maximum": 8, 
      "minimum": 0, 
      "required": false, 
      "title": "Congestion recovery scaling factor", 
      "type": "integer"
    }, 
    "idle_connection_timeout": {
      "default": 600, 
      "description": "The duration for keepalive probes or session idle timeout. Max value is 3600 seconds, min is 5. Set to 0 to allow infinite idle time. Allowed values are 5-14400. Special values are 0 - 'infinite'. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 600.", 
      "maximum": 14400, 
      "minimum": 0, 
      "required": false, 
      "title": "Idle connection timeout", 
      "type": "integer"
    }, 
    "idle_connection_type": {
      "$ref": "ALBIdleConnectionType, 
      "default": "KEEP_ALIVE", 
      "description": "Controls the behavior of idle connections. Enum options - KEEP_ALIVE, CLOSE_IDLE. Default value when not specified in API or module is interpreted by ALB Controller as KEEP_ALIVE.", 
      "required": false, 
      "title": "Idle connection type"
    }, 
    "ignore_time_wait": {
      "default": false, 
      "description": "A new SYN is accepted from the same 4-tuple even if there is already a connection in TIME_WAIT state. This is equivalent of setting Time Wait Delay to 0. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Ignore time wait", 
      "type": "boolean"
    }, 
    "ip_dscp": {
      "default": 0, 
      "description": "Controls the value of the Differentiated Services Code Point field inserted in the IP header. This has two options   Set to a specific value, or Pass Through, which uses the incoming DSCP value. Allowed values are 0-63. Special values are MAX - 'Passthrough'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 63, 
      "minimum": 0, 
      "required": false, 
      "title": "Ip dscp", 
      "type": "integer"
    }, 
    "keepalive_in_halfclose_state": {
      "default": true, 
      "description": "Controls whether to keep the connection alive with keepalive messages in the TCP half close state. The interval for sending keepalive messages is 30s. If a timeout is already configured in the network profile, this will not override it. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Keepalive in halfclose state", 
      "type": "boolean"
    }, 
    "max_retransmissions": {
      "default": 8, 
      "description": "The number of attempts at retransmit before closing the connection. Allowed values are 3-8. Default value when not specified in API or module is interpreted by ALB Controller as 8.", 
      "maximum": 8, 
      "minimum": 3, 
      "required": false, 
      "title": "Max retransmissions", 
      "type": "integer"
    }, 
    "max_segment_size": {
      "description": "Maximum TCP segment size. Allowed values are 512-9000. Special values are 0 - 'Use Interface MTU'. Unit is BYTES.", 
      "maximum": 9000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max segment size", 
      "type": "integer"
    }, 
    "max_syn_retransmissions": {
      "default": 8, 
      "description": "The maximum number of attempts at retransmitting a SYN packet before giving up. Allowed values are 3-8. Default value when not specified in API or module is interpreted by ALB Controller as 8.", 
      "maximum": 8, 
      "minimum": 3, 
      "required": false, 
      "title": "Max syn retransmissions", 
      "type": "integer"
    }, 
    "min_rexmt_timeout": {
      "description": "The minimum wait time (in millisec) to retransmit packet. Allowed values are 50-5000. Unit is MILLISECONDS.", 
      "maximum": 5000, 
      "minimum": 50, 
      "required": false, 
      "title": "Min rexmt timeout", 
      "type": "integer"
    }, 
    "nagles_algorithm": {
      "default": false, 
      "description": "Consolidates small data packets to send clients fewer but larger packets. Adversely affects real time protocols such as telnet or SSH. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Nagles algorithm", 
      "type": "boolean"
    }, 
    "reassembly_queue_size": {
      "default": 0, 
      "description": "Maximum number of TCP segments that can be queued for reassembly. Configuring this to 0 disables the feature and provides unlimited queuing. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "required": false, 
      "title": "Reassembly queue size", 
      "type": "integer"
    }, 
    "receive_window": {
      "default": 64, 
      "description": "Size of the receive window. Allowed values are 2-65536. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 64.", 
      "maximum": 65536, 
      "minimum": 2, 
      "required": false, 
      "title": "Receive window", 
      "type": "integer"
    }, 
    "reorder_threshold": {
      "description": "Controls the number of duplicate acks required to trigger retransmission. Setting a higher value reduces retransmission caused by packet reordering. A larger value is recommended in public cloud environments where packet reordering is quite common. The default value is 8 in public cloud platforms (AWS, Azure, GCP), and 3 in other environments. Allowed values are 1-100.", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Reorder threshold", 
      "type": "integer"
    }, 
    "slow_start_scaling_factor": {
      "default": 1, 
      "description": "Congestion window scaling factor during slow start. Allowed values are 0-8. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 8, 
      "minimum": 0, 
      "required": false, 
      "title": "Slow start scaling factor", 
      "type": "integer"
    }, 
    "time_wait_delay": {
      "default": 2000, 
      "description": "The time (in millisec) to wait before closing a connection in the TIME_WAIT state. Allowed values are 500-2000. Special values are 0 - 'immediate'. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 2000.", 
      "maximum": 2000, 
      "minimum": 0, 
      "required": false, 
      "title": "Time wait delay", 
      "type": "integer"
    }, 
    "use_interface_mtu": {
      "default": true, 
      "description": "Use the interface MTU to calculate the TCP max segment size. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Use interface mtu", 
      "type": "boolean"
    }
  }, 
  "title": "TCPProxyProfile", 
  "type": "object"
}

ALBTacacsPlusAuthSettings (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer TacacsPlusAuthSettings object", 
  "id": "ALBTacacsPlusAuthSettings", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "authorization_attrs": {
      "description": "TACACS+ authorization attribute value pairs.", 
      "items": {
        "$ref": "ALBAuthTacacsPlusAttributeValuePair
      }, 
      "required": false, 
      "title": "Authorization attrs", 
      "type": "array"
    }, 
    "password": {
      "description": "TACACS+ server shared secret.", 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "port": {
      "default": 49, 
      "description": "TACACS+ server listening port. Default value when not specified in API or module is interpreted by ALB Controller as 49.", 
      "required": false, 
      "title": "Port", 
      "type": "integer"
    }, 
    "server": {
      "description": "TACACS+ server IP address or FQDN. Minimum of 1 items required.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Server", 
      "type": "array"
    }, 
    "service": {
      "$ref": "ALBAuthTacacsPlusService, 
      "default": "AUTH_TACACS_PLUS_SERVICE_LOGIN", 
      "description": "TACACS+ service. Enum options - AUTH_TACACS_PLUS_SERVICE_NONE, AUTH_TACACS_PLUS_SERVICE_LOGIN, AUTH_TACACS_PLUS_SERVICE_ENABLE, AUTH_TACACS_PLUS_SERVICE_PPP, AUTH_TACACS_PLUS_SERVICE_ARAP, AUTH_TACACS_PLUS_SERVICE_PT, AUTH_TACACS_PLUS_SERVICE_RCMD, AUTH_TACACS_PLUS_SERVICE_X25, AUTH_TACACS_PLUS_SERVICE_NASI, AUTH_TACACS_PLUS_SERVICE_FWPROXY. Default value when not specified in API or module is interpreted by ALB Controller as AUTH_TACACS_PLUS_SERVICE_LOGIN.", 
      "required": false, 
      "title": "Service"
    }
  }, 
  "title": "TacacsPlusAuthSettings", 
  "type": "object"
}

ALBTag (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Tag object", 
  "id": "ALBTag", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "type": {
      "$ref": "ALBTagType, 
      "default": "USER_DEFINED", 
      "description": "Enum options - AVI_DEFINED, USER_DEFINED, VCENTER_DEFINED. Default value when not specified in API or module is interpreted by ALB Controller as USER_DEFINED.", 
      "required": false, 
      "title": "Type"
    }, 
    "value": {
      "description": "value of Tag.", 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "Tag", 
  "type": "object"
}

ALBTagType (type)

{
  "description": "Valid ENUM values for ALBTagType", 
  "enum": [
    "AVI_DEFINED", 
    "USER_DEFINED", 
    "VCENTER_DEFINED"
  ], 
  "id": "ALBTagType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "TagType type", 
  "type": "string"
}

ALBTrafficCloneProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer TrafficCloneProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBTrafficCloneProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "clone_servers": {
      "description": "Maximum of 10 items allowed.", 
      "items": {
        "$ref": "ALBCloneServer
      }, 
      "required": false, 
      "title": "Clone servers", 
      "type": "array"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "preserve_client_ip": {
      "default": false, 
      "description": "Specifies if client IP needs to be preserved to clone destination. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Preserve client ip", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "TrafficCloneProfile", 
  "type": "object"
}

ALBTrafficCloneProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "TrafficCloneProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBTrafficCloneProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of TrafficCloneProfile", 
      "items": {
        "$ref": "ALBTrafficCloneProfile
      }, 
      "required": false, 
      "title": "Array of TrafficCloneProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "TrafficCloneProfileApiResponse", 
  "type": "object"
}

ALBUDPFastPathProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer UDPFastPathProfile object", 
  "id": "ALBUDPFastPathProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "dsr_profile": {
      "$ref": "ALBDsrProfile, 
      "description": "DSR profile information. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Dsr profile"
    }, 
    "per_pkt_loadbalance": {
      "default": false, 
      "description": "When enabled, every UDP packet is considered a new transaction and may be load balanced to a different server. When disabled, packets from the same client source IP and port are sent to the same server. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Per pkt loadbalance", 
      "type": "boolean"
    }, 
    "session_idle_timeout": {
      "default": 10, 
      "description": "The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "maximum": 3600, 
      "minimum": 2, 
      "required": false, 
      "title": "Session idle timeout", 
      "type": "integer"
    }, 
    "snat": {
      "default": true, 
      "description": "When disabled, Source NAT will not be performed for all client UDP packets. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Snat", 
      "type": "boolean"
    }
  }, 
  "title": "UDPFastPathProfile", 
  "type": "object"
}

ALBUDPProxyProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer UDPProxyProfile object", 
  "id": "ALBUDPProxyProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "session_idle_timeout": {
      "default": 10, 
      "description": "The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10.", 
      "maximum": 3600, 
      "minimum": 2, 
      "required": false, 
      "title": "Session idle timeout", 
      "type": "integer"
    }
  }, 
  "title": "UDPProxyProfile", 
  "type": "object"
}

ALBURIParam (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer URIParam object", 
  "id": "ALBURIParam", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "tokens": {
      "description": "Token config either for the URI components or a constant string. Minimum of 1 items required.", 
      "items": {
        "$ref": "ALBURIParamToken
      }, 
      "required": true, 
      "title": "Tokens", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ALBURIParamType, 
      "description": "URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "URIParam", 
  "type": "object"
}

ALBURIParamQuery (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer URIParamQuery object", 
  "id": "ALBURIParamQuery", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "add_string": {
      "description": "Concatenate a string to the query of the incoming request URI and then use it in the request URI going to the backend server.", 
      "required": false, 
      "title": "Add string", 
      "type": "string"
    }, 
    "keep_query": {
      "default": true, 
      "description": "Use or drop the query of the incoming request URI in the request URI to the backend server. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Keep query", 
      "type": "boolean"
    }
  }, 
  "title": "URIParamQuery", 
  "type": "object"
}

ALBURIParamToken (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer URIParamToken object", 
  "id": "ALBURIParamToken", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "end_index": {
      "description": "Index of the ending token in the incoming URI. Allowed values are 0-65534. Special values are 65535 - 'end of string'.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "End index", 
      "type": "integer"
    }, 
    "start_index": {
      "description": "Index of the starting token in the incoming URI.", 
      "required": false, 
      "title": "Start index", 
      "type": "integer"
    }, 
    "str_value": {
      "description": "Constant string to use as a token.", 
      "required": false, 
      "title": "Str value", 
      "type": "string"
    }, 
    "type": {
      "$ref": "ALBURITokenType, 
      "description": "Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX.", 
      "required": true, 
      "title": "Type"
    }
  }, 
  "title": "URIParamToken", 
  "type": "object"
}

ALBURIParamType (type)

{
  "description": "Valid ENUM values for ALBURIParamType", 
  "enum": [
    "URI_PARAM_TYPE_TOKENIZED"
  ], 
  "id": "ALBURIParamType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "URIParamType type", 
  "type": "string"
}

ALBURITokenType (type)

{
  "description": "Valid ENUM values for ALBURITokenType", 
  "enum": [
    "URI_TOKEN_TYPE_HOST", 
    "URI_TOKEN_TYPE_PATH", 
    "URI_TOKEN_TYPE_STRING", 
    "URI_TOKEN_TYPE_STRING_GROUP", 
    "URI_TOKEN_TYPE_REGEX"
  ], 
  "id": "ALBURITokenType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "URITokenType type", 
  "type": "string"
}

ALBVSDataScript (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VSDataScript object", 
  "id": "ALBVSDataScript", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "evt": {
      "$ref": "ALBVSDataScriptEvent, 
      "description": "Event triggering execution of datascript. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_HTTP_LB_DONE, VS_DATASCRIPT_EVT_HTTP_AUTH, VS_DATASCRIPT_EVT_HTTP_POST_AUTH, VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT, VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE, VS_DATASCRIPT_EVT_DNS_REQ, VS_DATASCRIPT_EVT_DNS_RESP, VS_DATASCRIPT_EVT_L4_REQUEST, VS_DATASCRIPT_EVT_L4_RESPONSE, VS_DATASCRIPT_EVT_MAX. Allowed in Basic(Allowed values- VS_DATASCRIPT_EVT_HTTP_REQ) edition, Enterprise edition.", 
      "required": true, 
      "title": "Evt"
    }, 
    "script": {
      "description": "Datascript to execute when the event triggers.", 
      "required": true, 
      "title": "Script", 
      "type": "string"
    }
  }, 
  "title": "VSDataScript", 
  "type": "object"
}

ALBVSDataScriptEvent (type)

{
  "description": "Valid ENUM values for ALBVSDataScriptEvent", 
  "enum": [
    "VS_DATASCRIPT_EVT_HTTP_REQ", 
    "VS_DATASCRIPT_EVT_HTTP_RESP", 
    "VS_DATASCRIPT_EVT_HTTP_RESP_DATA", 
    "VS_DATASCRIPT_EVT_HTTP_LB_FAILED", 
    "VS_DATASCRIPT_EVT_HTTP_REQ_DATA", 
    "VS_DATASCRIPT_EVT_HTTP_RESP_FAILED", 
    "VS_DATASCRIPT_EVT_HTTP_LB_DONE", 
    "VS_DATASCRIPT_EVT_HTTP_AUTH", 
    "VS_DATASCRIPT_EVT_HTTP_POST_AUTH", 
    "VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT", 
    "VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE", 
    "VS_DATASCRIPT_EVT_DNS_REQ", 
    "VS_DATASCRIPT_EVT_DNS_RESP", 
    "VS_DATASCRIPT_EVT_L4_REQUEST", 
    "VS_DATASCRIPT_EVT_L4_RESPONSE", 
    "VS_DATASCRIPT_EVT_MAX"
  ], 
  "id": "ALBVSDataScriptEvent", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "VSDataScriptEvent type", 
  "type": "string"
}

ALBVSDataScriptSet (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VSDataScriptSet object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBVSDataScriptSet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "datascript": {
      "description": "DataScripts to execute.", 
      "items": {
        "$ref": "ALBVSDataScript
      }, 
      "required": false, 
      "title": "Datascript", 
      "type": "array"
    }, 
    "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"
    }, 
    "ipgroup_paths": {
      "description": "path of IP Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type IpAddrGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Ipgroup paths", 
      "type": "array"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "pool_group_paths": {
      "description": "path of pool groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type PoolGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Pool group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVSDataScriptSet"
          ], 
          "relationshipType": "ALB_VSDATASCRIPTSET_ALB_POOLGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroup"
          ]
        }
      ]
    }, 
    "pool_paths": {
      "description": "path of pools that could be referred by VSDataScriptSet objects. It is a reference to an object of type Pool.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Pool paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVSDataScriptSet"
          ], 
          "relationshipType": "ALB_VSDATASCRIPTSET_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }, 
    "protocol_parser_paths": {
      "description": "List of protocol parsers that could be referred by VSDataScriptSet objects. It is a reference to an object of type ProtocolParser. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Protocol parser paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVSDataScriptSet"
          ], 
          "relationshipType": "ALB_VSDATASCRIPTSET_ALB_PROTOCOLPARSER_RELATIONSHIP", 
          "rightType": [
            "ALBProtocolParser"
          ]
        }
      ]
    }, 
    "rate_limiters": {
      "description": "The Rate Limit definitions needed for this DataScript. The name is composed of the Virtual Service name and the DataScript name. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRateLimiter
      }, 
      "required": false, 
      "title": "Rate limiters", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "string_group_paths": {
      "description": "path of String Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type StringGroup.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "String group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVSDataScriptSet"
          ], 
          "relationshipType": "ALB_VSDATASCRIPTSET_ALB_STRINGGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBStringGroup"
          ]
        }
      ]
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "VSDataScriptSet", 
  "type": "object"
}

ALBVSDataScriptSetApiResponse (type)

{
  "additionalProperties": false, 
  "description": "VSDataScriptSetApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBVSDataScriptSetApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of VSDataScriptSet", 
      "items": {
        "$ref": "ALBVSDataScriptSet
      }, 
      "required": false, 
      "title": "Array of VSDataScriptSet", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "VSDataScriptSetApiResponse", 
  "type": "object"
}

ALBVSDataScripts (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VSDataScripts object", 
  "id": "ALBVSDataScripts", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "index": {
      "description": "Index of the virtual service datascript collection.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "vs_datascript_set_path": {
      "description": "path of the virtual service datascript collection. It is a reference to an object of type VSDataScriptSet.", 
      "required": true, 
      "title": "Vs datascript set path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_VSDATASCRIPTSET_RELATIONSHIP", 
          "rightType": [
            "ALBVSDataScriptSet"
          ]
        }
      ]
    }
  }, 
  "title": "VSDataScripts", 
  "type": "object"
}

ALBVip (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Vip object", 
  "id": "ALBVip", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "auto_allocate_floating_ip": {
      "default": false, 
      "description": "Auto-allocate floating/elastic IP from the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Auto allocate floating ip", 
      "type": "boolean"
    }, 
    "auto_allocate_ip": {
      "default": false, 
      "description": "Auto-allocate VIP from the provided subnet. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Auto allocate ip", 
      "type": "boolean"
    }, 
    "auto_allocate_ip_type": {
      "$ref": "ALBIpAddressVersions, 
      "default": "V4_ONLY", 
      "description": "Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Allowed in Basic(Allowed values- V4_ONLY) edition, Essentials(Allowed values- V4_ONLY) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as V4_ONLY.", 
      "required": false, 
      "title": "Auto allocate ip type"
    }, 
    "availability_zone": {
      "description": "Availability-zone to place the Virtual Service. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Availability zone", 
      "type": "string"
    }, 
    "avi_allocated_fip": {
      "default": false, 
      "description": "(internal-use) FIP allocated by Avi in the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Avi allocated fip", 
      "type": "boolean"
    }, 
    "avi_allocated_vip": {
      "default": false, 
      "description": "(internal-use) VIP allocated by Avi in the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Avi allocated vip", 
      "type": "boolean"
    }, 
    "discovered_networks": {
      "description": "Discovered networks providing reachability for client facing Vip IP.", 
      "items": {
        "$ref": "ALBDiscoveredNetwork
      }, 
      "required": false, 
      "title": "Discovered networks", 
      "type": "array"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable or disable the Vip. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "floating_ip": {
      "$ref": "ALBIpAddr, 
      "description": "Floating IPv4 to associate with this Vip. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Floating ip"
    }, 
    "floating_ip6": {
      "$ref": "ALBIpAddr, 
      "description": "Floating IPv6 address to associate with this Vip. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Floating ip6"
    }, 
    "floating_subnet6_uuid": {
      "description": "If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Floating subnet6 uuid", 
      "type": "string"
    }, 
    "floating_subnet_uuid": {
      "description": "If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Floating subnet uuid", 
      "type": "string"
    }, 
    "ip6_address": {
      "$ref": "ALBIpAddr, 
      "description": "IPv6 Address of the Vip.", 
      "required": false, 
      "title": "Ip6 address"
    }, 
    "ip_address": {
      "$ref": "ALBIpAddr, 
      "description": "IPv4 Address of the VIP.", 
      "required": false, 
      "title": "Ip address"
    }, 
    "ipam_network_subnet": {
      "$ref": "ALBIPNetworkSubnet, 
      "description": "Subnet and/or Network for allocating VirtualService IP by IPAM Provider module.", 
      "required": false, 
      "title": "Ipam network subnet"
    }, 
    "network_name": {
      "description": "Manually override the network on which the Vip is placed. It is a reference to an object of type Network.", 
      "required": false, 
      "title": "Network name", 
      "type": "string"
    }, 
    "placement_networks": {
      "description": "Placement networks/subnets to use for vip placement. Maximum of 10 items allowed.", 
      "items": {
        "$ref": "ALBVipPlacementNetwork
      }, 
      "required": false, 
      "title": "Placement networks", 
      "type": "array"
    }, 
    "port_uuid": {
      "description": "(internal-use) Network port assigned to the Vip IP address.", 
      "required": false, 
      "title": "Port uuid", 
      "type": "string"
    }, 
    "prefix_length": {
      "default": 32, 
      "description": "Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Allowed in Basic(Allowed values- 32) edition, Essentials(Allowed values- 32) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 32.", 
      "maximum": 32, 
      "minimum": 0, 
      "required": false, 
      "title": "Prefix length", 
      "type": "integer"
    }, 
    "subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Subnet providing reachability for client facing Vip IP.", 
      "required": false, 
      "title": "Subnet"
    }, 
    "subnet6": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Subnet providing reachability for client facing Vip IPv6. Allowed in Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Subnet6"
    }, 
    "subnet6_uuid": {
      "description": "If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Allowed in Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Subnet6 uuid", 
      "type": "string"
    }, 
    "subnet_uuid": {
      "description": "If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected.", 
      "required": false, 
      "title": "Subnet uuid", 
      "type": "string"
    }, 
    "vip_id": {
      "description": "Unique ID associated with the vip.", 
      "required": true, 
      "title": "Vip id", 
      "type": "string"
    }
  }, 
  "title": "Vip", 
  "type": "object"
}

ALBVipPlacementNetwork (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VipPlacementNetwork object", 
  "id": "ALBVipPlacementNetwork", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "network_name": {
      "description": "Network to use for vip placement. It is a reference to an object of type Network.", 
      "required": false, 
      "title": "Network name", 
      "type": "string"
    }, 
    "subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "IPv4 Subnet to use for vip placement.", 
      "required": false, 
      "title": "Subnet"
    }, 
    "subnet6": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "IPv6 subnet to use for vip placement.", 
      "required": false, 
      "title": "Subnet6"
    }
  }, 
  "title": "VipPlacementNetwork", 
  "type": "object"
}

ALBVirtualService (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VirtualService object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBVirtualService", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "active_standby_se_tag": {
      "$ref": "ALBActiveStandbySeTag, 
      "default": "ACTIVE_STANDBY_SE_1", 
      "description": "This configuration only applies if the VirtualService is in Legacy Active Standby HA mode and Load Distribution among Active Standby is enabled. This field is used to tag the VirtualService so that VirtualServices with the same tag will share the same Active ServiceEngine. VirtualServices with different tags will have different Active ServiceEngines. If one of the ServiceEngine's in the ServiceEngineGroup fails, all VirtualServices will end up using the same Active ServiceEngine. Redistribution of the VirtualServices can be either manual or automated when the failed ServiceEngine recovers. Redistribution is based on the auto redistribute property of the ServiceEngineGroup. Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. Default value when not specified in API or module is interpreted by ALB Controller as ACTIVE_STANDBY_SE_1.", 
      "required": false, 
      "title": "Active standby se tag"
    }, 
    "advertise_down_vs": {
      "default": false, 
      "description": "Keep advertising Virtual Service via BGP even if it is marked down by health monitor. This setting takes effect for future Virtual Service flaps. To advertise current VSes that are down, please disable and re-enable the Virtual Service. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Advertise down vs", 
      "type": "boolean"
    }, 
    "allow_invalid_client_cert": {
      "default": false, 
      "description": "Process request even if invalid client certificate is presented. Datascript APIs need to be used for processing of such requests. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Allow invalid client cert", 
      "type": "boolean"
    }, 
    "analytics_policy": {
      "$ref": "ALBAnalyticsPolicy, 
      "description": "Determines analytics settings for the application.", 
      "required": false, 
      "title": "Analytics policy"
    }, 
    "analytics_profile_path": {
      "description": "Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.", 
      "required": false, 
      "title": "Analytics profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_ANALYTICSPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBAnalyticsProfile"
          ]
        }
      ]
    }, 
    "apic_contract_graph": {
      "description": "The name of the Contract/Graph associated with the Virtual Service. Should be in the <Contract name> <Graph name> format. This is applicable only for Service Integration mode with Cisco APIC Controller. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Apic contract graph", 
      "type": "string"
    }, 
    "application_profile_path": {
      "description": "Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile. Special default for Essentials edition is System-L4-Application.", 
      "required": false, 
      "title": "Application profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_APPLICATIONPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBApplicationProfile"
          ]
        }
      ]
    }, 
    "azure_availability_set": {
      "description": "(internal-use)Applicable for Azure only. Azure Availability set to which this VS is associated. Internally set by the cloud connector.", 
      "required": false, 
      "title": "Azure availability set", 
      "type": "string"
    }, 
    "bgp_peer_labels": {
      "description": "Select BGP peers, using peer label, for VsVip advertisement. Maximum of 128 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Bgp peer labels", 
      "type": "array"
    }, 
    "bulk_sync_kvcache": {
      "default": false, 
      "description": "(This is a beta feature). Sync Key-Value cache to the new SEs when VS is scaled out. For ex  SSL sessions are stored using VS's Key-Value cache. When the VS is scaled out, the SSL session information is synced to the new SE, allowing existing SSL sessions to be reused on the new SE. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Bulk sync kvcache", 
      "type": "boolean"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "client_auth": {
      "$ref": "ALBHTTPClientAuthenticationParams, 
      "description": "HTTP authentication configuration for protected resources.", 
      "required": false, 
      "title": "Client auth"
    }, 
    "close_client_conn_on_config_update": {
      "default": false, 
      "description": "close client connection on vs config update. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Close client conn on config update", 
      "type": "boolean"
    }, 
    "cloud_config_cksum": {
      "description": "Checksum of cloud configuration for VS. Internally set by cloud connector.", 
      "required": false, 
      "title": "Cloud config cksum", 
      "type": "string"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "cloud_type": {
      "$ref": "ALBCloudType, 
      "default": "CLOUD_NONE", 
      "description": "Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Basic(Allowed values- CLOUD_NONE,CLOUD_NSXT) edition, Essentials(Allowed values- CLOUD_NONE,CLOUD_VCENTER) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as CLOUD_NONE.", 
      "required": false, 
      "title": "Cloud type"
    }, 
    "connections_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate limit the incoming connections to this virtual service.", 
      "required": false, 
      "title": "Connections rate limit"
    }, 
    "content_rewrite": {
      "$ref": "ALBContentRewriteProfile, 
      "description": "Profile used to match and rewrite strings in request and/or response body.", 
      "required": false, 
      "title": "Content rewrite"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "delay_fairness": {
      "default": false, 
      "description": "Select the algorithm for QoS fairness. This determines how multiple Virtual Services sharing the same Service Engines will prioritize traffic over a congested network. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Delay fairness", 
      "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"
    }, 
    "dns_info": {
      "description": "Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Note that only one of fqdn and dns_info setting is allowed. Maximum of 1000 items allowed.", 
      "items": {
        "$ref": "ALBDnsInfo
      }, 
      "required": false, 
      "title": "Dns info", 
      "type": "array"
    }, 
    "dns_policies": {
      "description": "DNS Policies applied on the dns traffic of the Virtual Service. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBDnsPolicies
      }, 
      "required": false, 
      "title": "Dns policies", 
      "type": "array"
    }, 
    "east_west_placement": {
      "default": false, 
      "description": "Force placement on all SE's in service group (Mesos mode only). Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "East west placement", 
      "type": "boolean"
    }, 
    "enable_autogw": {
      "default": false, 
      "description": "Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable autogw", 
      "type": "boolean"
    }, 
    "enable_rhi": {
      "description": "Enable Route Health Injection using the BGP Config in the vrf context.", 
      "required": false, 
      "title": "Enable rhi", 
      "type": "boolean"
    }, 
    "enable_rhi_snat": {
      "description": "Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context.", 
      "required": false, 
      "title": "Enable rhi snat", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable or disable the Virtual Service. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "error_page_profile_path": {
      "description": "Error Page Profile to be used for this virtualservice.This profile is used to send the custom error page to the client generated by the proxy. It is a reference to an object of type ErrorPageProfile. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Error page profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_ERRORPAGEPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBErrorPageProfile"
          ]
        }
      ]
    }, 
    "flow_dist": {
      "$ref": "ALBSeFlowDist, 
      "default": "LOAD_AWARE", 
      "description": "Criteria for flow distribution among SEs. Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. Allowed in Basic(Allowed values- LOAD_AWARE) edition, Essentials(Allowed values- LOAD_AWARE) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as LOAD_AWARE.", 
      "required": false, 
      "title": "Flow dist"
    }, 
    "flow_label_type": {
      "$ref": "ALBFlowLabelType, 
      "default": "NO_LABEL", 
      "description": "Criteria for flow labelling. Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL. Default value when not specified in API or module is interpreted by ALB Controller as NO_LABEL.", 
      "required": false, 
      "title": "Flow label type"
    }, 
    "fqdn": {
      "description": "DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed.", 
      "required": false, 
      "title": "Fqdn", 
      "type": "string"
    }, 
    "group_paths": {
      "description": "A list of NSX Groups representing the Clients which can access the Virtual IP of the Virtual Service.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Group paths", 
      "type": "array"
    }, 
    "host_name_xlate": {
      "description": "Translate the host name sent to the servers to this value. Translate the host name sent from servers back to the value used by the client.", 
      "required": false, 
      "title": "Host name xlate", 
      "type": "string"
    }, 
    "http_policies": {
      "description": "HTTP Policies applied on the data traffic of the Virtual Service.", 
      "items": {
        "$ref": "ALBHTTPPolicies
      }, 
      "required": false, 
      "title": "Http policies", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ign_pool_net_reach": {
      "default": false, 
      "description": "Ignore Pool servers network reachability constraints for Virtual Service placement. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Ign pool net reach", 
      "type": "boolean"
    }, 
    "l4_policies": {
      "description": "L4 Policies applied to the data traffic of the Virtual Service.", 
      "items": {
        "$ref": "ALBL4Policies
      }, 
      "required": false, 
      "title": "L4 policies", 
      "type": "array"
    }, 
    "limit_doser": {
      "default": false, 
      "description": "Limit potential DoS attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Limit doser", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "max_cps_per_client": {
      "default": 0, 
      "description": "Maximum connections per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max cps per client", 
      "type": "integer"
    }, 
    "min_pools_up": {
      "description": "Minimum number of UP pools to mark VS up.", 
      "required": false, 
      "title": "Min pools up", 
      "type": "integer"
    }, 
    "network_profile_path": {
      "description": "Determines network settings such as protocol, TCP or UDP, and related options for the protocol. It is a reference to an object of type NetworkProfile. Special default for Essentials edition is System-TCP-Fast-Path.", 
      "required": false, 
      "title": "Network profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_NETWORKPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBNetworkProfile"
          ]
        }
      ]
    }, 
    "network_security_policy_path": {
      "description": "Network security policies for the Virtual Service. It is a reference to an object of type NetworkSecurityPolicy.", 
      "required": false, 
      "title": "Network security policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_NETWORKSECURITYPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBNetworkSecurityPolicy"
          ]
        }
      ]
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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_limits": {
      "$ref": "ALBPerformanceLimits, 
      "description": "Optional settings that determine performance limits like max connections or bandwdith etc.", 
      "required": false, 
      "title": "Performance limits"
    }, 
    "pool_group_path": {
      "description": "The pool group is an object that contains pools. It is a reference to an object of type PoolGroup.", 
      "required": false, 
      "title": "Pool group path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_POOLGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBPoolGroup"
          ]
        }
      ]
    }, 
    "pool_path": {
      "description": "The pool is an object that contains destination servers and related attributes such as load-balancing and persistence. It is a reference to an object of type Pool.", 
      "required": false, 
      "title": "Pool path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "remove_listening_port_on_vs_down": {
      "default": false, 
      "description": "Remove listening port if VirtualService is down. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Remove listening port on vs down", 
      "type": "boolean"
    }, 
    "requests_rate_limit": {
      "$ref": "ALBRateProfile, 
      "description": "Rate limit the incoming requests to this virtual service.", 
      "required": false, 
      "title": "Requests rate limit"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "saml_sp_config": {
      "$ref": "ALBSAMLSPConfig, 
      "description": "Application-specific SAML config. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Saml sp config"
    }, 
    "se_group_name": {
      "description": "The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS. It is a reference to an object of type ServiceEngineGroup.", 
      "required": false, 
      "title": "Se group name", 
      "type": "string"
    }, 
    "security_policy_path": {
      "description": "Security policy applied on the traffic of the Virtual Service. This policy is used to perform security actions such as Distributed Denial of Service (DDoS) attack mitigation, etc. It is a reference to an object of type SecurityPolicy. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Security policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SECURITYPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBSecurityPolicy"
          ]
        }
      ]
    }, 
    "server_network_profile_path": {
      "description": "Determines the network settings profile for the server side of TCP proxied connections. Leave blank to use the same settings as the client to VS side of the connection. It is a reference to an object of type NetworkProfile.", 
      "required": false, 
      "title": "Server network profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_NETWORKPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBNetworkProfile"
          ]
        }
      ]
    }, 
    "service_metadata": {
      "description": "Metadata pertaining to the Service provided by this virtual service. In Openshift/Kubernetes environments, egress pod info is stored. Any user input to this field will be overwritten by Avi Vantage.", 
      "required": false, 
      "title": "Service metadata", 
      "type": "string"
    }, 
    "service_pool_select": {
      "description": "Select pool based on destination port.", 
      "items": {
        "$ref": "ALBServicePoolSelector
      }, 
      "required": false, 
      "title": "Service pool select", 
      "type": "array"
    }, 
    "services": {
      "description": "List of Services defined for this Virtual Service. Maximum of 2048 items allowed.", 
      "items": {
        "$ref": "ALBService
      }, 
      "required": false, 
      "title": "Services", 
      "type": "array"
    }, 
    "sideband_profile": {
      "$ref": "ALBSidebandProfile, 
      "description": "Sideband configuration to be used for this virtualservice.It can be used for sending traffic to sideband VIPs for external inspection etc.", 
      "required": false, 
      "title": "Sideband profile"
    }, 
    "snat_ip": {
      "description": "NAT'ted floating source IP Address(es) for upstream connection to servers. Maximum of 32 items allowed.", 
      "items": {
        "$ref": "ALBIpAddr
      }, 
      "required": false, 
      "title": "Snat ip", 
      "type": "array"
    }, 
    "sp_pool_paths": {
      "description": "GSLB pools used to manage site-persistence functionality. Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the GSLB manager. This is a read-only field for the user. It is a reference to an object of type Pool.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Sp pool paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_POOL_RELATIONSHIP", 
          "rightType": [
            "ALBPool"
          ]
        }
      ]
    }, 
    "ssl_key_and_certificate_paths": {
      "description": "Select or create one or two certificates, EC and/or RSA, that will be presented to SSL/TLS terminated connections. It is a reference to an object of type SSLKeyAndCertificate.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Ssl key and certificate paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SSLKEYANDCERTIFICATE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLKeyAndCertificate"
          ]
        }
      ]
    }, 
    "ssl_profile_path": {
      "description": "Determines the set of SSL versions and ciphers to accept for SSL/TLS terminated connections. It is a reference to an object of type SSLProfile.", 
      "required": false, 
      "title": "Ssl profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SSLPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBSSLProfile"
          ]
        }
      ]
    }, 
    "ssl_profile_selectors": {
      "description": "Select SSL Profile based on client IP address match. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBSSLProfileSelector
      }, 
      "required": false, 
      "title": "Ssl profile selectors", 
      "type": "array"
    }, 
    "ssl_sess_cache_avg_size": {
      "default": 1024, 
      "description": "Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. Default value when not specified in API or module is interpreted by ALB Controller as 1024.", 
      "maximum": 16383, 
      "minimum": 1024, 
      "required": false, 
      "title": "Ssl sess cache avg size", 
      "type": "integer"
    }, 
    "sso_policy_path": {
      "description": "The SSO Policy attached to the virtualservice. It is a reference to an object of type SSOPolicy. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Sso policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_SSOPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBSSOPolicy"
          ]
        }
      ]
    }, 
    "static_dns_records": {
      "description": "List of static DNS records applied to this Virtual Service. These are static entries and no health monitoring is performed against the IP addresses. Maximum of 1000 items allowed.", 
      "items": {
        "$ref": "ALBDnsRecord
      }, 
      "required": false, 
      "title": "Static dns records", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "topology_policies": {
      "description": "Topology Policies applied on the dns traffic of the Virtual Service based onGSLB Topology algorithm. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBDnsPolicies
      }, 
      "required": false, 
      "title": "Topology policies", 
      "type": "array"
    }, 
    "traffic_clone_profile_path": {
      "description": "Server network or list of servers for cloning traffic. It is a reference to an object of type TrafficCloneProfile. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Traffic clone profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_TRAFFICCLONEPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBTrafficCloneProfile"
          ]
        }
      ]
    }, 
    "traffic_enabled": {
      "default": true, 
      "description": "Knob to enable the Virtual Service traffic on its assigned service engines. This setting is effective only when the enabled flag is set to True. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Traffic enabled", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "ALBVirtualServiceType, 
      "default": "VS_TYPE_NORMAL", 
      "description": "Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service. Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Allowed in Basic(Allowed values- VS_TYPE_NORMAL,VS_TYPE_VH_PARENT) edition, Essentials(Allowed values- VS_TYPE_NORMAL) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as VS_TYPE_NORMAL.", 
      "required": false, 
      "title": "Type"
    }, 
    "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"
    }, 
    "use_bridge_ip_as_vip": {
      "default": false, 
      "description": "Use Bridge IP as VIP on each Host in Mesos deployments. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use bridge ip as vip", 
      "type": "boolean"
    }, 
    "use_vip_as_snat": {
      "default": false, 
      "description": "Use the Virtual IP as the SNAT IP for health monitoring and sending traffic to the backend servers instead of the Service Engine interface IP. The caveat of enabling this option is that the VirtualService cannot be configured in an Active-Active HA mode. DNS based Multi VIP solution has to be used for HA & Non-disruptive Upgrade purposes. Allowed in Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Use vip as snat", 
      "type": "boolean"
    }, 
    "vh_domain_name": {
      "description": "The exact name requested from the client's SNI-enabled TLS hello domain name field. If this is a match, the parent VS will forward the connection to this child VS.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Vh domain name", 
      "type": "array"
    }, 
    "vh_parent_vs_uuid": {
      "description": "Specifies the Virtual Service acting as Virtual Hosting (SNI) parent.", 
      "required": false, 
      "title": "Vh parent vs uuid", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_VIRTUALSERVICE_RELATIONSHIP", 
          "rightType": [
            "ALBVirtualService"
          ]
        }
      ]
    }, 
    "vip": {
      "description": "List of Virtual Service IPs. While creating a 'Shared VS',please use vsvip_ref to point to the shared entities.", 
      "items": {
        "$ref": "ALBVip
      }, 
      "required": false, 
      "title": "Vip", 
      "type": "array"
    }, 
    "vrf_context_name": {
      "description": "Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext.", 
      "required": false, 
      "title": "Vrf context name", 
      "type": "string"
    }, 
    "vs_datascripts": {
      "description": "Datascripts applied on the data traffic of the Virtual Service.", 
      "items": {
        "$ref": "ALBVSDataScripts
      }, 
      "required": false, 
      "title": "Vs datascripts", 
      "type": "array"
    }, 
    "vsvip_path": {
      "description": "Mostly used during the creation of Shared VS, this field refers to entities that can be shared across Virtual Services. It is a reference to an object of type VsVip.", 
      "required": false, 
      "title": "Vsvip path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_VSVIP_RELATIONSHIP", 
          "rightType": [
            "ALBVsVip"
          ]
        }
      ]
    }, 
    "waf_policy_path": {
      "description": "WAF policy for the Virtual Service. It is a reference to an object of type WafPolicy. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Waf policy path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBVirtualService"
          ], 
          "relationshipType": "ALB_VIRTUALSERVICE_ALB_WAFPOLICY_RELATIONSHIP", 
          "rightType": [
            "ALBWafPolicy"
          ]
        }
      ]
    }, 
    "weight": {
      "default": 1, 
      "description": "The Quality of Service weight to assign to traffic transmitted from this Virtual Service. A higher weight will prioritize traffic versus other Virtual Services sharing the same Service Engines. Allowed values are 1-128. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 1.", 
      "maximum": 128, 
      "minimum": 1, 
      "required": false, 
      "title": "Weight", 
      "type": "integer"
    }
  }, 
  "title": "VirtualService", 
  "type": "object"
}

ALBVirtualServiceApiResponse (type)

{
  "additionalProperties": false, 
  "description": "VirtualServiceApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBVirtualServiceApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of VirtualService", 
      "items": {
        "$ref": "ALBVirtualService
      }, 
      "required": false, 
      "title": "Array of VirtualService", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "VirtualServiceApiResponse", 
  "type": "object"
}

ALBVirtualServiceType (type)

{
  "description": "Valid ENUM values for ALBVirtualServiceType", 
  "enum": [
    "VS_TYPE_NORMAL", 
    "VS_TYPE_VH_PARENT", 
    "VS_TYPE_VH_CHILD"
  ], 
  "id": "ALBVirtualServiceType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "VirtualServiceType type", 
  "type": "string"
}

ALBVsVip (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer VsVip object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBVsVip", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "bgp_peer_labels": {
      "description": "Select BGP peers, using peer label, for VsVip advertisement. Maximum of 128 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Bgp peer labels", 
      "type": "array"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cloud_name": {
      "description": "It is a reference to an object of type Cloud.", 
      "required": false, 
      "title": "Cloud name", 
      "type": "string"
    }, 
    "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"
    }, 
    "dns_info": {
      "description": "Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Maximum of 1000 items allowed. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBDnsInfo
      }, 
      "required": false, 
      "title": "Dns info", 
      "type": "array"
    }, 
    "east_west_placement": {
      "default": false, 
      "description": "Force placement on all Service Engines in the Service Engine Group (Container clouds only). Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "East west placement", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tier1_path": {
      "description": "This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t.", 
      "required": false, 
      "title": "Tier1 path", 
      "type": "string"
    }, 
    "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"
    }, 
    "use_standard_alb": {
      "description": "This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "required": false, 
      "title": "Use standard alb", 
      "type": "boolean"
    }, 
    "vip": {
      "description": "List of Virtual Service IPs and other shareable entities.", 
      "items": {
        "$ref": "ALBVip
      }, 
      "required": false, 
      "title": "Vip", 
      "type": "array"
    }, 
    "vrf_context_name": {
      "description": "Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext.", 
      "required": false, 
      "title": "Vrf context name", 
      "type": "string"
    }, 
    "vsvip_cloud_config_cksum": {
      "description": "Checksum of cloud configuration for VsVip. Internally set by cloud connector.", 
      "required": false, 
      "title": "Vsvip cloud config cksum", 
      "type": "string"
    }
  }, 
  "title": "VsVip", 
  "type": "object"
}

ALBVsVipApiResponse (type)

{
  "additionalProperties": false, 
  "description": "VsVipApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBVsVipApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of VsVip", 
      "items": {
        "$ref": "ALBVsVip
      }, 
      "required": false, 
      "title": "Array of VsVip", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "VsVipApiResponse", 
  "type": "object"
}

ALBWafAction (type)

{
  "description": "Valid ENUM values for ALBWafAction", 
  "enum": [
    "WAF_ACTION_NO_OP", 
    "WAF_ACTION_BLOCK", 
    "WAF_ACTION_ALLOW_PARAMETER"
  ], 
  "id": "ALBWafAction", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafAction type", 
  "type": "string"
}

ALBWafApplicationSignatures (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafApplicationSignatures object", 
  "id": "ALBWafApplicationSignatures", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "rule_overrides": {
      "description": "Override attributes of application signature rules.", 
      "items": {
        "$ref": "ALBWafRuleOverrides
      }, 
      "required": false, 
      "title": "Rule overrides", 
      "type": "array"
    }, 
    "ruleset_version": {
      "description": "The version in use of the provided ruleset.", 
      "required": false, 
      "title": "Ruleset version", 
      "type": "string"
    }, 
    "selected_applications": {
      "description": "List of applications for which we use the rules from the WafApplicationSignatureProvider. Maximum of 8 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Selected applications", 
      "type": "array"
    }
  }, 
  "title": "WafApplicationSignatures", 
  "type": "object"
}

ALBWafCRS (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafCRS object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBWafCRS", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "groups": {
      "description": "WAF Rules are sorted in groups based on their characterization. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafRuleGroup
      }, 
      "required": false, 
      "title": "Groups", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "integrity": {
      "description": "Integrity protection value.", 
      "required": true, 
      "title": "Integrity", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "release_date": {
      "description": "The release date of this version in RFC 3339 / ISO 8601 format.", 
      "required": true, 
      "title": "Release date", 
      "type": "string"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "version": {
      "description": "The version of this ruleset object.", 
      "required": true, 
      "title": "Version", 
      "type": "string"
    }
  }, 
  "title": "WafCRS", 
  "type": "object"
}

ALBWafCRSApiResponse (type)

{
  "additionalProperties": false, 
  "description": "WafCRSApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBWafCRSApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of WafCRS", 
      "items": {
        "$ref": "ALBWafCRS
      }, 
      "required": false, 
      "title": "Array of WafCRS", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "WafCRSApiResponse", 
  "type": "object"
}

ALBWafConfig (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafConfig object", 
  "id": "ALBWafConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "allowed_http_versions": {
      "description": "WAF allowed HTTP Versions. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Maximum of 8 items allowed.", 
      "items": {
        "$ref": "ALBHTTPVersion
      }, 
      "required": false, 
      "title": "Allowed http versions", 
      "type": "array"
    }, 
    "allowed_methods": {
      "description": "WAF allowed HTTP methods. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK.", 
      "items": {
        "$ref": "ALBHTTPMethod
      }, 
      "required": false, 
      "title": "Allowed methods", 
      "type": "array"
    }, 
    "allowed_request_content_types": {
      "description": "WAF allowed Content Types. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Allowed request content types", 
      "type": "array"
    }, 
    "argument_separator": {
      "default": "&", 
      "description": "Argument seperator. Default value when not specified in API or module is interpreted by ALB Controller as &.", 
      "required": false, 
      "title": "Argument separator", 
      "type": "string"
    }, 
    "client_request_max_body_size": {
      "default": 32, 
      "description": "Maximum size for the client request body scanned by WAF. Allowed values are 1-32768. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 32.", 
      "maximum": 32768, 
      "minimum": 1, 
      "required": false, 
      "title": "Client request max body size", 
      "type": "integer"
    }, 
    "cookie_format_version": {
      "default": 0, 
      "description": "0  For Netscape Cookies. 1  For version 1 cookies. Allowed values are 0-1. Default value when not specified in API or module is interpreted by ALB Controller as 0.", 
      "maximum": 1, 
      "minimum": 0, 
      "required": false, 
      "title": "Cookie format version", 
      "type": "integer"
    }, 
    "ignore_incomplete_request_body_error": {
      "default": true, 
      "description": "Ignore request body parsing errors due to partial scanning. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Ignore incomplete request body error", 
      "type": "boolean"
    }, 
    "max_execution_time": {
      "default": 50, 
      "description": "The maximum period of time WAF processing is allowed to take for a single request. A value of 0 (zero) means no limit and should not be chosen in production deployments. It is only used for exceptional situations where crashes of se_dp processes are acceptable. The behavior of the system if this time is exceeded depends on two other configuration settings, the WAF policy mode and the WAF failure mode. In WAF policy mode 'Detection', the request is allowed and flagged for both failure mode 'Closed' and 'Open'. In enforcement node, 'Closed' means the request is rejected, 'Open' means the request is allowed and flagged. Irrespective of these settings, no subsequent WAF rules of this or other phases will be executed once the maximum execution time has been exceeded. Allowed values are 0-5000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 50.", 
      "maximum": 5000, 
      "minimum": 0, 
      "required": false, 
      "title": "Max execution time", 
      "type": "integer"
    }, 
    "regex_match_limit": {
      "default": 30000, 
      "description": "Limit CPU utilization for each regular expression match when processing rules. Default value when not specified in API or module is interpreted by ALB Controller as 30000.", 
      "required": false, 
      "title": "Regex match limit", 
      "type": "integer"
    }, 
    "regex_recursion_limit": {
      "default": 10000, 
      "description": "Limit depth of recursion for each regular expression match when processing rules. Default value when not specified in API or module is interpreted by ALB Controller as 10000.", 
      "required": false, 
      "title": "Regex recursion limit", 
      "type": "integer"
    }, 
    "request_body_default_action": {
      "default": "phase:2,deny,status:403,log,auditlog", 
      "description": "WAF default action for Request Body Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:2,deny,status:403,log,auditlog.", 
      "required": false, 
      "title": "Request body default action", 
      "type": "string"
    }, 
    "request_hdr_default_action": {
      "default": "phase:1,deny,status:403,log,auditlog", 
      "description": "WAF default action for Request Header Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:1,deny,status:403,log,auditlog.", 
      "required": false, 
      "title": "Request hdr default action", 
      "type": "string"
    }, 
    "response_body_default_action": {
      "default": "phase:4,deny,status:403,log,auditlog", 
      "description": "WAF default action for Response Body Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:4,deny,status:403,log,auditlog.", 
      "required": false, 
      "title": "Response body default action", 
      "type": "string"
    }, 
    "response_hdr_default_action": {
      "default": "phase:3,deny,status:403,log,auditlog", 
      "description": "WAF default action for Response Header Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:3,deny,status:403,log,auditlog.", 
      "required": false, 
      "title": "Response hdr default action", 
      "type": "string"
    }, 
    "restricted_extensions": {
      "description": "WAF Restricted File Extensions. Maximum of 256 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Restricted extensions", 
      "type": "array"
    }, 
    "restricted_headers": {
      "description": "WAF Restricted HTTP Headers. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Restricted headers", 
      "type": "array"
    }, 
    "server_response_max_body_size": {
      "default": 128, 
      "description": "Maximum size for response body scanned by WAF. Allowed values are 1-32768. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 128.", 
      "maximum": 32768, 
      "minimum": 1, 
      "required": false, 
      "title": "Server response max body size", 
      "type": "integer"
    }, 
    "static_extensions": {
      "description": "WAF Static File Extensions. GET and HEAD requests with no query args and one of these extensions are allowed and not checked by the ruleset. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Static extensions", 
      "type": "array"
    }, 
    "status_code_for_rejected_requests": {
      "$ref": "ALBHTTPResponseCodes, 
      "default": "HTTP_RESPONSE_CODE_403", 
      "description": "HTTP status code used by WAF Positive Security Model when rejecting a request. Enum options - HTTP_RESPONSE_CODE_0, HTTP_RESPONSE_CODE_100, HTTP_RESPONSE_CODE_101, HTTP_RESPONSE_CODE_200, HTTP_RESPONSE_CODE_201, HTTP_RESPONSE_CODE_202, HTTP_RESPONSE_CODE_203, HTTP_RESPONSE_CODE_204, HTTP_RESPONSE_CODE_205, HTTP_RESPONSE_CODE_206, HTTP_RESPONSE_CODE_300, HTTP_RESPONSE_CODE_301, HTTP_RESPONSE_CODE_302, HTTP_RESPONSE_CODE_303, HTTP_RESPONSE_CODE_304, HTTP_RESPONSE_CODE_305, HTTP_RESPONSE_CODE_307, HTTP_RESPONSE_CODE_400, HTTP_RESPONSE_CODE_401, HTTP_RESPONSE_CODE_402... Default value when not specified in API or module is interpreted by ALB Controller as HTTP_RESPONSE_CODE_403.", 
      "required": false, 
      "title": "Status code for rejected requests"
    }, 
    "xml_xxe_protection": {
      "default": true, 
      "description": "Block or flag XML requests referring to External Entities. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Xml xxe protection", 
      "type": "boolean"
    }
  }, 
  "title": "WafConfig", 
  "type": "object"
}

ALBWafDataFile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafDataFile object", 
  "id": "ALBWafDataFile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "data": {
      "description": "Stringified WAF File Data.", 
      "required": true, 
      "title": "Data", 
      "type": "string"
    }, 
    "name": {
      "description": "WAF Data File Name.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "type": {
      "$ref": "ALBWafDataFileType, 
      "default": "WAF_DATAFILE_PM_FROM_FILE", 
      "description": "WAF data file type. Enum options - WAF_DATAFILE_PM_FROM_FILE, WAF_DATAFILE_DTD, WAF_DATAFILE_XSD. Default value when not specified in API or module is interpreted by ALB Controller as WAF_DATAFILE_PM_FROM_FILE.", 
      "required": false, 
      "title": "Type"
    }
  }, 
  "title": "WafDataFile", 
  "type": "object"
}

ALBWafDataFileType (type)

{
  "description": "Valid ENUM values for ALBWafDataFileType", 
  "enum": [
    "WAF_DATAFILE_PM_FROM_FILE", 
    "WAF_DATAFILE_DTD", 
    "WAF_DATAFILE_XSD"
  ], 
  "id": "ALBWafDataFileType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafDataFileType type", 
  "type": "string"
}

ALBWafExcludeListEntry (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafExcludeListEntry object", 
  "id": "ALBWafExcludeListEntry", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "client_subnet": {
      "$ref": "ALBIpAddrPrefix, 
      "description": "Client IP Subnet to exclude for WAF rules.", 
      "required": false, 
      "title": "Client subnet"
    }, 
    "description": {
      "description": "Free-text comment about this exclusion.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "match_element": {
      "description": "The match_element can be 'ARGS xxx', 'ARGS_GET xxx', 'ARGS_POST xxx', 'ARGS_NAMES xxx', 'FILES xxx', 'QUERY_STRING', 'REQUEST_BASENAME', 'REQUEST_BODY', 'REQUEST_URI', 'REQUEST_URI_RAW', 'REQUEST_COOKIES xxx', 'REQUEST_HEADERS xxx' or 'RESPONSE_HEADERS xxx'. These match_elements in the HTTP Transaction (if present) will be excluded when executing WAF Rules.", 
      "required": false, 
      "title": "Match element", 
      "type": "string"
    }, 
    "match_element_criteria": {
      "$ref": "ALBWafExclusionType, 
      "description": "Criteria for match_element matching.", 
      "required": false, 
      "title": "Match element criteria"
    }, 
    "uri_match_criteria": {
      "$ref": "ALBWafExclusionType, 
      "description": "Criteria for URI matching.", 
      "required": false, 
      "title": "Uri match criteria"
    }, 
    "uri_path": {
      "description": "URI Path to exclude for WAF rules.", 
      "required": false, 
      "title": "Uri path", 
      "type": "string"
    }
  }, 
  "title": "WafExcludeListEntry", 
  "type": "object"
}

ALBWafExclusionType (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafExclusionType object", 
  "id": "ALBWafExclusionType", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "SENSITIVE", 
      "description": "Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as SENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_op": {
      "$ref": "ALBStringOperation, 
      "default": "EQUALS", 
      "description": "String Operation to use for matching the Exclusion. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Default value when not specified in API or module is interpreted by ALB Controller as EQUALS.", 
      "required": false, 
      "title": "Match op"
    }
  }, 
  "title": "WafExclusionType", 
  "type": "object"
}

ALBWafFailureMode (type)

{
  "description": "Valid ENUM values for ALBWafFailureMode", 
  "enum": [
    "WAF_FAILURE_MODE_OPEN", 
    "WAF_FAILURE_MODE_CLOSED"
  ], 
  "id": "ALBWafFailureMode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafFailureMode type", 
  "type": "string"
}

ALBWafMode (type)

{
  "description": "Valid ENUM values for ALBWafMode", 
  "enum": [
    "WAF_MODE_DETECTION_ONLY", 
    "WAF_MODE_ENFORCEMENT"
  ], 
  "id": "ALBWafMode", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafMode type", 
  "type": "string"
}

ALBWafPSMLocation (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPSMLocation object", 
  "id": "ALBWafPSMLocation", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "description": {
      "description": "Free-text comment about this location.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "index": {
      "description": "Location index, this is used to determine the order of the locations.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match": {
      "$ref": "ALBWafPSMLocationMatch, 
      "description": "Apply these rules only if the request is matching this description.", 
      "required": false, 
      "title": "Match"
    }, 
    "name": {
      "description": "User defined name for this location, it must be unique in the group.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "rules": {
      "description": "A list of rules which should be applied on this location. Maximum of 1024 items allowed.", 
      "items": {
        "$ref": "ALBWafPSMRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "WafPSMLocation", 
  "type": "object"
}

ALBWafPSMLocationMatch (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPSMLocationMatch object", 
  "id": "ALBWafPSMLocationMatch", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "host": {
      "$ref": "ALBHostHdrMatch, 
      "description": "Apply the rules only to requests that match the specified Host header. If this is not set, the host header will not be checked.", 
      "required": false, 
      "title": "Host"
    }, 
    "methods": {
      "$ref": "ALBMethodMatch, 
      "description": "Apply the rules only to requests that have the specified methods. If this is not set, the method will not be checked.", 
      "required": false, 
      "title": "Methods"
    }, 
    "path": {
      "$ref": "ALBPathMatch, 
      "description": "Apply the rules only to requests that match the specified URI. If this is not set, the path will not be checked.", 
      "required": false, 
      "title": "Path"
    }
  }, 
  "title": "WafPSMLocationMatch", 
  "type": "object"
}

ALBWafPSMMatchElement (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPSMMatchElement object", 
  "id": "ALBWafPSMMatchElement", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "excluded": {
      "default": false, 
      "description": "Mark this element excluded, like in '!ARGS password'. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Excluded", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Match_element index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "name": {
      "$ref": "ALBWafVariable, 
      "description": "The variable specification. For example ARGS or REQUEST_COOKIES. This can be a scalar like PATH_INFO. Enum options - WAF_VARIABLE_ARGS, WAF_VARIABLE_ARGS_GET, WAF_VARIABLE_ARGS_POST, WAF_VARIABLE_ARGS_NAMES, WAF_VARIABLE_REQUEST_COOKIES, WAF_VARIABLE_QUERY_STRING, WAF_VARIABLE_REQUEST_BASENAME, WAF_VARIABLE_REQUEST_URI, WAF_VARIABLE_PATH_INFO.", 
      "required": true, 
      "title": "Name"
    }, 
    "sub_element": {
      "description": "The name of the request collection element. This can be empty, if we address the whole collection or a scalar element.", 
      "required": false, 
      "title": "Sub element", 
      "type": "string"
    }
  }, 
  "title": "WafPSMMatchElement", 
  "type": "object"
}

ALBWafPSMRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPSMRule object", 
  "id": "ALBWafPSMRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "description": {
      "description": "Free-text comment about this rule.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable this rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Rule index, this is used to determine the order of the rules.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_elements": {
      "description": "The match elements, for example ARGS id or ARGS|!ARGS password. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafPSMMatchElement
      }, 
      "required": false, 
      "title": "Match elements", 
      "type": "array"
    }, 
    "match_value_max_length": {
      "description": "The maximum allowed length of the match_value. If this is not set, the length will not be checked.", 
      "required": false, 
      "title": "Match value max length", 
      "type": "integer"
    }, 
    "match_value_pattern": {
      "description": "A regular expression which describes the expected value.", 
      "required": false, 
      "title": "Match value pattern", 
      "type": "string"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "description": "WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.", 
      "required": false, 
      "title": "Mode"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "paranoia_level": {
      "$ref": "ALBWafParanoiaLevel, 
      "default": "WAF_PARANOIA_LEVEL_LOW", 
      "description": "WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Default value when not specified in API or module is interpreted by ALB Controller as WAF_PARANOIA_LEVEL_LOW.", 
      "required": false, 
      "title": "Paranoia level"
    }, 
    "rule_id": {
      "description": "Id field which is used for log and metric generation. This id must be unique for all rules in this group.", 
      "required": true, 
      "title": "Rule id", 
      "type": "string"
    }
  }, 
  "title": "WafPSMRule", 
  "type": "object"
}

ALBWafParanoiaLevel (type)

{
  "description": "Valid ENUM values for ALBWafParanoiaLevel", 
  "enum": [
    "WAF_PARANOIA_LEVEL_LOW", 
    "WAF_PARANOIA_LEVEL_MEDIUM", 
    "WAF_PARANOIA_LEVEL_HIGH", 
    "WAF_PARANOIA_LEVEL_EXTREME"
  ], 
  "id": "ALBWafParanoiaLevel", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafParanoiaLevel type", 
  "type": "string"
}

ALBWafPhase (type)

{
  "description": "Valid ENUM values for ALBWafPhase", 
  "enum": [
    "WAF_PHASE_CONNECTION", 
    "WAF_PHASE_REQUEST_HEADER", 
    "WAF_PHASE_REQUEST_BODY", 
    "WAF_PHASE_RESPONSE_HEADER", 
    "WAF_PHASE_RESPONSE_BODY", 
    "WAF_PHASE_LOGGING"
  ], 
  "id": "ALBWafPhase", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafPhase type", 
  "type": "string"
}

ALBWafPolicy (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPolicy object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBWafPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "allow_mode_delegation": {
      "default": true, 
      "description": "Allow Rules to overwrite the policy mode. This must be set if the policy mode is set to enforcement. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Allow mode delegation", 
      "type": "boolean"
    }, 
    "application_signatures": {
      "$ref": "ALBWafApplicationSignatures, 
      "description": "Application Specific Signatures.", 
      "required": false, 
      "title": "Application signatures"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "confidence_override": {
      "$ref": "ALBAppLearningConfidenceOverride, 
      "description": "Configure thresholds for confidence labels.", 
      "required": false, 
      "title": "Confidence override"
    }, 
    "created_by": {
      "description": "Creator name.", 
      "required": false, 
      "title": "Created by", 
      "type": "string"
    }, 
    "crs_overrides": {
      "description": "Override attributes for CRS rules.", 
      "items": {
        "$ref": "ALBWafRuleGroupOverrides
      }, 
      "required": false, 
      "title": "Crs overrides", 
      "type": "array"
    }, 
    "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"
    }, 
    "enable_app_learning": {
      "default": false, 
      "description": "Enable Application Learning for this WAF policy. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Enable app learning", 
      "type": "boolean"
    }, 
    "enable_auto_rule_updates": {
      "default": true, 
      "description": "Enable Application Learning based rule updates on the WAF Profile. Rules will be programmed in dedicated WAF learning group. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable auto rule updates", 
      "type": "boolean"
    }, 
    "failure_mode": {
      "$ref": "ALBWafFailureMode, 
      "default": "WAF_FAILURE_MODE_OPEN", 
      "description": "WAF Policy failure mode. This can be 'Open' or 'Closed'. Enum options - WAF_FAILURE_MODE_OPEN, WAF_FAILURE_MODE_CLOSED. Default value when not specified in API or module is interpreted by ALB Controller as WAF_FAILURE_MODE_OPEN.", 
      "required": false, 
      "title": "Failure mode"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "learning_params": {
      "$ref": "ALBAppLearningParams, 
      "description": "Parameters for tuning Application learning.", 
      "required": false, 
      "title": "Learning params"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "min_confidence": {
      "$ref": "ALBAppLearningConfidenceLabel, 
      "default": "CONFIDENCE_VERY_HIGH", 
      "description": "Minimum confidence label required for auto rule updates. Enum options - CONFIDENCE_VERY_HIGH, CONFIDENCE_HIGH, CONFIDENCE_PROBABLE, CONFIDENCE_LOW, CONFIDENCE_NONE. Default value when not specified in API or module is interpreted by ALB Controller as CONFIDENCE_VERY_HIGH.", 
      "required": false, 
      "title": "Min confidence"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "default": "WAF_MODE_DETECTION_ONLY", 
      "description": "WAF Policy mode. This can be detection or enforcement. It can be overwritten by rules if allow_mode_delegation is set. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Default value when not specified in API or module is interpreted by ALB Controller as WAF_MODE_DETECTION_ONLY.", 
      "required": false, 
      "title": "Mode"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "paranoia_level": {
      "$ref": "ALBWafParanoiaLevel, 
      "default": "WAF_PARANOIA_LEVEL_LOW", 
      "description": "WAF Ruleset paranoia  mode. This is used to select Rules based on the paranoia-level tag. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Default value when not specified in API or module is interpreted by ALB Controller as WAF_PARANOIA_LEVEL_LOW.", 
      "required": false, 
      "title": "Paranoia level"
    }, 
    "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"
    }, 
    "positive_security_model": {
      "$ref": "ALBWafPositiveSecurityModel, 
      "description": "The Positive Security Model. This is used to describe how the request or parts of the request should look like. It is executed in the Request Body Phase of Avi WAF.", 
      "required": false, 
      "title": "Positive security model"
    }, 
    "post_crs_groups": {
      "description": "WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be enforced after the CRS groups.", 
      "items": {
        "$ref": "ALBWafRuleGroup
      }, 
      "required": false, 
      "title": "Post crs groups", 
      "type": "array"
    }, 
    "pre_crs_groups": {
      "description": "WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be  enforced before the CRS groups.", 
      "items": {
        "$ref": "ALBWafRuleGroup
      }, 
      "required": false, 
      "title": "Pre crs groups", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "waf_crs_path": {
      "description": "WAF core ruleset used for the CRS part of this Policy. It is a reference to an object of type WafCRS.", 
      "required": false, 
      "title": "Waf crs path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_WAFCRS_RELATIONSHIP", 
          "rightType": [
            "ALBWafCRS"
          ]
        }
      ]
    }, 
    "waf_profile_path": {
      "description": "WAF Profile for WAF policy. It is a reference to an object of type WafProfile.", 
      "required": true, 
      "title": "Waf profile path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_WAFPROFILE_RELATIONSHIP", 
          "rightType": [
            "ALBWafProfile"
          ]
        }
      ]
    }
  }, 
  "title": "WafPolicy", 
  "type": "object"
}

ALBWafPolicyApiResponse (type)

{
  "additionalProperties": false, 
  "description": "WafPolicyApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBWafPolicyApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of WafPolicy", 
      "items": {
        "$ref": "ALBWafPolicy
      }, 
      "required": false, 
      "title": "Array of WafPolicy", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "WafPolicyApiResponse", 
  "type": "object"
}

ALBWafPolicyPSMGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPolicyPSMGroup object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBWafPolicyPSMGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable this WAF rule group. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "hit_action": {
      "$ref": "ALBWafAction, 
      "default": "WAF_ACTION_ALLOW_PARAMETER", 
      "description": "If a rule in this group matches the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_ALLOW_PARAMETER. Default value when not specified in API or module is interpreted by ALB Controller as WAF_ACTION_ALLOW_PARAMETER.", 
      "required": false, 
      "title": "Hit action"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_learning_group": {
      "default": false, 
      "description": "This field indicates that this group is used for learning. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is learning group", 
      "type": "boolean"
    }, 
    "locations": {
      "description": "Positive Security Model locations. These are used to partition the application name space. Maximum of 16384 items allowed.", 
      "items": {
        "$ref": "ALBWafPSMLocation
      }, 
      "required": false, 
      "title": "Locations", 
      "type": "array"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "miss_action": {
      "$ref": "ALBWafAction, 
      "default": "WAF_ACTION_NO_OP", 
      "description": "If a rule in this group does not match the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_BLOCK. Default value when not specified in API or module is interpreted by ALB Controller as WAF_ACTION_NO_OP.", 
      "required": false, 
      "title": "Miss action"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "WafPolicyPSMGroup", 
  "type": "object"
}

ALBWafPolicyPSMGroupApiResponse (type)

{
  "additionalProperties": false, 
  "description": "WafPolicyPSMGroupApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBWafPolicyPSMGroupApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of WafPolicyPSMGroup", 
      "items": {
        "$ref": "ALBWafPolicyPSMGroup
      }, 
      "required": false, 
      "title": "Array of WafPolicyPSMGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "WafPolicyPSMGroupApiResponse", 
  "type": "object"
}

ALBWafPositiveSecurityModel (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPositiveSecurityModel object", 
  "id": "ALBWafPositiveSecurityModel", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "group_paths": {
      "description": "These groups should be used to separate different levels of concern. The order of the groups matters, one group may mark parts of the request as valid, so that subsequent groups will not check these parts. It is a reference to an object of type WafPolicyPSMGroup. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "ALBWafPolicy"
          ], 
          "relationshipType": "ALB_WAFPOLICY_ALB_WAFPOLICYPSMGROUP_RELATIONSHIP", 
          "rightType": [
            "ALBWafPolicyPSMGroup"
          ]
        }
      ]
    }
  }, 
  "title": "WafPositiveSecurityModel", 
  "type": "object"
}

ALBWafProfile (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafProfile object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBWafProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "config": {
      "$ref": "ALBWafConfig, 
      "description": "Config params for WAF.", 
      "required": true, 
      "title": "Config"
    }, 
    "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"
    }, 
    "files": {
      "description": "List of Data Files Used for WAF Rules. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafDataFile
      }, 
      "required": false, 
      "title": "Files", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "WafProfile", 
  "type": "object"
}

ALBWafProfileApiResponse (type)

{
  "additionalProperties": false, 
  "description": "WafProfileApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBWafProfileApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of WafProfile", 
      "items": {
        "$ref": "ALBWafProfile
      }, 
      "required": false, 
      "title": "Array of WafProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "WafProfileApiResponse", 
  "type": "object"
}

ALBWafRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafRule object", 
  "id": "ALBWafRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "avi_tags": {
      "description": "Tags for WAF rule as per Modsec language. They are extracted from the tag actions in a Modsec rule. This field is generated from the rule itself and cannot be set by the user. Maximum of 64 items allowed.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Avi tags", 
      "type": "array"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable WAF Rule Group. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "exclude_list": {
      "description": "Exclude list for the WAF rule. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafExcludeListEntry
      }, 
      "required": false, 
      "title": "Exclude list", 
      "type": "array"
    }, 
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "is_sensitive": {
      "default": false, 
      "description": "The rule field is sensitive and will not be displayed. Default value when not specified in API or module is interpreted by ALB Controller as false.", 
      "required": false, 
      "title": "Is sensitive", 
      "type": "boolean"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "description": "WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.", 
      "required": false, 
      "title": "Mode"
    }, 
    "name": {
      "description": "User-friendly optional name for a rule.", 
      "required": false, 
      "title": "Name", 
      "type": "string"
    }, 
    "phase": {
      "$ref": "ALBWafPhase, 
      "description": "The execution phase where this rule will be executed. Enum options - WAF_PHASE_CONNECTION, WAF_PHASE_REQUEST_HEADER, WAF_PHASE_REQUEST_BODY, WAF_PHASE_RESPONSE_HEADER, WAF_PHASE_RESPONSE_BODY, WAF_PHASE_LOGGING.", 
      "required": false, 
      "title": "Phase"
    }, 
    "rule": {
      "description": "Rule as per Modsec language.", 
      "required": true, 
      "title": "Rule", 
      "type": "string"
    }, 
    "rule_id": {
      "description": "Identifier (id) for a rule per Modsec language. All SecRule and SecAction directives require an id. It is extracted from the id action in a Modsec rule. Rules within a single WAF Policy are required to have unique rule_ids.", 
      "required": false, 
      "title": "Rule id", 
      "type": "string"
    }
  }, 
  "title": "WafRule", 
  "type": "object"
}

ALBWafRuleGroup (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafRuleGroup object", 
  "id": "ALBWafRuleGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable": {
      "default": true, 
      "description": "Enable or disable WAF Rule Group. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "exclude_list": {
      "description": "Exclude list for the WAF rule group. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafExcludeListEntry
      }, 
      "required": false, 
      "title": "Exclude list", 
      "type": "array"
    }, 
    "index": {
      "description": "Number of index.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "name": {
      "description": "Name of the object.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "rules": {
      "description": "Rules as per Modsec language. Maximum of 1024 items allowed.", 
      "items": {
        "$ref": "ALBWafRule
      }, 
      "required": false, 
      "title": "Rules", 
      "type": "array"
    }
  }, 
  "title": "WafRuleGroup", 
  "type": "object"
}

ALBWafRuleGroupOverrides (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafRuleGroupOverrides object", 
  "id": "ALBWafRuleGroupOverrides", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable": {
      "description": "Override the enable flag for this group.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "exclude_list": {
      "description": "Replace the exclude list for this group. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafExcludeListEntry
      }, 
      "required": false, 
      "title": "Exclude list", 
      "type": "array"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "description": "Override the waf mode for this group. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.", 
      "required": false, 
      "title": "Mode"
    }, 
    "name": {
      "description": "The name of the group where attributes or rules are overridden.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "rule_overrides": {
      "description": "Rule specific overrides. Maximum of 1024 items allowed.", 
      "items": {
        "$ref": "ALBWafRuleOverrides
      }, 
      "required": false, 
      "title": "Rule overrides", 
      "type": "array"
    }
  }, 
  "title": "WafRuleGroupOverrides", 
  "type": "object"
}

ALBWafRuleOverrides (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafRuleOverrides object", 
  "id": "ALBWafRuleOverrides", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "enable": {
      "description": "Override the enable flag for this rule.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "exclude_list": {
      "description": "Replace the exclude list for this rule. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafExcludeListEntry
      }, 
      "required": false, 
      "title": "Exclude list", 
      "type": "array"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "description": "Override the waf mode for this rule. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.", 
      "required": false, 
      "title": "Mode"
    }, 
    "rule_id": {
      "description": "The rule_id of the rule where attributes are overridden.", 
      "required": true, 
      "title": "Rule id", 
      "type": "string"
    }
  }, 
  "title": "WafRuleOverrides", 
  "type": "object"
}

ALBWafVariable (type)

{
  "description": "Valid ENUM values for ALBWafVariable", 
  "enum": [
    "WAF_VARIABLE_ARGS", 
    "WAF_VARIABLE_ARGS_GET", 
    "WAF_VARIABLE_ARGS_POST", 
    "WAF_VARIABLE_ARGS_NAMES", 
    "WAF_VARIABLE_REQUEST_COOKIES", 
    "WAF_VARIABLE_QUERY_STRING", 
    "WAF_VARIABLE_REQUEST_BASENAME", 
    "WAF_VARIABLE_REQUEST_URI", 
    "WAF_VARIABLE_PATH_INFO"
  ], 
  "id": "ALBWafVariable", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "title": "WafVariable type", 
  "type": "string"
}

ALBWebhook (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer Webhook object", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ALBWebhook", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "callback_url": {
      "description": "Callback URL for the Webhook.", 
      "required": false, 
      "title": "Callback url", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "markers": {
      "description": "List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.", 
      "items": {
        "$ref": "ALBRoleFilterMatchLabel
      }, 
      "required": false, 
      "title": "Markers", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "verification_token": {
      "description": "Verification token sent back with the callback asquery parameters.", 
      "required": false, 
      "title": "Verification token", 
      "type": "string"
    }
  }, 
  "title": "Webhook", 
  "type": "object"
}

ALBWebhookApiResponse (type)

{
  "additionalProperties": false, 
  "description": "WebhookApiResponse", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ALBWebhookApiResponse", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "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"
    }, 
    "count": {
      "default": null, 
      "description": "count", 
      "required": false, 
      "title": "count", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Webhook", 
      "items": {
        "$ref": "ALBWebhook
      }, 
      "required": false, 
      "title": "Array of Webhook", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "WebhookApiResponse", 
  "type": "object"
}

ALGTypeNSService (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement
  }, 
  "id": "ALGTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ALGTypeNSService"
  }, 
  "properties": {
    "alg": {
      "description": "The Application Layer Gateway (ALG) protocol. Please note, protocol NBNS_BROADCAST and NBDG_BROADCAST are  deprecated. Please use UDP protocol and create L4 Port Set type of service instead.", 
      "enum": [
        "ORACLE_TNS", 
        "FTP", 
        "SUN_RPC_TCP", 
        "SUN_RPC_UDP", 
        "MS_RPC_TCP", 
        "MS_RPC_UDP", 
        "NBNS_BROADCAST", 
        "NBDG_BROADCAST", 
        "TFTP"
      ], 
      "required": true, 
      "title": "The Application Layer Gateway (ALG) protocol", 
      "type": "string"
    }, 
    "destination_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "minItems": 1, 
      "required": true, 
      "title": "The destination_port cannot be empty and must be a single value.", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "required": false, 
      "title": "Source ports", 
      "type": "array"
    }
  }, 
  "title": "An NSService element that represents an ALG protocol", 
  "type": "object"
}

ALGTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "ALGTypeServiceEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ALGTypeServiceEntry"
  }, 
  "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"
    }, 
    "alg": {
      "description": "The Application Layer Gateway (ALG) protocol. Please note, protocol NBNS_BROADCAST and NBDG_BROADCAST are  deprecated. Please use UDP protocol and create L4 Port Set type of service instead.", 
      "enum": [
        "ORACLE_TNS", 
        "FTP", 
        "SUN_RPC_TCP", 
        "SUN_RPC_UDP", 
        "MS_RPC_TCP", 
        "MS_RPC_UDP", 
        "NBNS_BROADCAST", 
        "NBDG_BROADCAST", 
        "TFTP"
      ], 
      "required": true, 
      "title": "The Application Layer Gateway (ALG) protocol", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "The destination_port cannot be empty and must be a single value.", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "An ServiceEntry that represents an ALG protocol", 
  "type": "object"
}

AbstractSpace (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents the space in which the policy is being defined.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "AbstractSpace", 
  "module_id": "Policy", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connectivity_strategy": {
      "deprecated": true, 
      "description": "The connectivity strategy is deprecated. Use default layer3 rule, /infra/domains/default/security-policies/default-layer3-security-policy/rules/default-layer3-rule. This field indicates the default connectivity policy for the infra or tenant space WHITELIST - Adds a default drop rule. Administrator can then use \"allow\" rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use \"drop\" rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "WHITELIST_ENABLE_LOGGING", 
        "BLACKLIST_ENABLE_LOGGING", 
        "NONE"
      ], 
      "required": false, 
      "title": "Connectivity strategy used by this tenant", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "The space in which policy is being defined", 
  "type": "object"
}

AcceptableComponentVersion (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "VersionList
  }, 
  "id": "AcceptableComponentVersion", 
  "module_id": "VersionWhitelist", 
  "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"
    }, 
    "acceptable_versions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of component versions", 
      "type": "array"
    }, 
    "component_type": {
      "enum": [
        "HOST", 
        "EDGE", 
        "CCP", 
        "MP"
      ], 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AcceptableComponentVersionList (type)

{
  "additionalProperties": false, 
  "id": "AcceptableComponentVersionList", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "results": {
      "items": {
        "$ref": "AcceptableComponentVersion
      }, 
      "required": true, 
      "title": "Acceptable version whitelist for different components", 
      "type": "array"
    }
  }, 
  "type": "object"
}

Action (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Reaction Action is the action to take when the stipulated criteria specified in the event exist over the source. Some example actions include: - Notify Admin (or VMC's SRE) via email. - Populate a specific label with the IPSec VPN Session. - Remove the IPSec VPN Session from a specific label.", 
  "id": "Action", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Reaction Action resource type.", 
      "enum": [
        "PatchResources", 
        "SetFields"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Reaction Action", 
  "type": "object"
}

ActionRequest (type)

{
  "additionalProperties": false, 
  "id": "ActionRequest", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "action": {
      "description": "Action required to be performed on intent", 
      "title": "Action to be performed", 
      "type": "string"
    }
  }, 
  "title": "Action request object", 
  "type": "object"
}

ActionableResource (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ActionableResource", 
  "module_id": "ClusterRestore", 
  "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"
    }, 
    "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"
    }, 
    "ip_address": {
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "A resource reference on which actions can be performed", 
      "type": "string"
    }, 
    "ipv6_address": {
      "description": "IPv6 address of the current node", 
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "ipv6 address", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Resources managed during restore process", 
  "type": "object"
}

ActionableResourceListRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ActionableResourceListRequestParameters", 
  "module_id": "ClusterRestore", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "instruction_id": {
      "required": true, 
      "title": "Id of the instruction set whose instructions are to be returned", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActionableResourceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ActionableResourceListResult", 
  "module_id": "ClusterRestore", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ActionableResource
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActiveDirectoryIdentitySource (type)

{
  "description": "An identity source service that runs Microsoft Active Directory. The service allows selected user accounts defined in Active Directory to log into and access NSX-T.", 
  "extends": {
    "$ref": "LdapIdentitySource
  }, 
  "id": "ActiveDirectoryIdentitySource", 
  "module_id": "LdapIdentitySources", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ActiveDirectoryIdentitySource"
  }, 
  "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"
    }, 
    "alternative_domain_names": {
      "description": "After parsing the \"user@domain\", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.", 
      "items": {
        "type": "string"
      }, 
      "title": "Additional domains to be directed to this identity source", 
      "type": "array"
    }, 
    "base_dn": {
      "description": "The subtree of the LDAP identity source to search when locating users and groups.", 
      "required": true, 
      "title": "DN of subtree for user and group searches", 
      "type": "string"
    }, 
    "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"
    }, 
    "domain_name": {
      "description": "The name of the authentication domain. When users log into NSX using an identity of the form \"user@domain\", NSX uses the domain portion to determine which LDAP identity source to use.", 
      "required": true, 
      "title": "Authentication domain name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.", 
      "items": {
        "$ref": "IdentitySourceLdapServer
      }, 
      "maxItems": 3, 
      "title": "LDAP servers for this identity source", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "ActiveDirectoryIdentitySource", 
        "OpenLdapIdentitySource"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An Active Directory identity source service", 
  "type": "object"
}

ActiveStandbySyncStatus (type)

{
  "id": "ActiveStandbySyncStatus", 
  "module_id": "SiteManagerModule", 
  "properties": {
    "description": {
      "required": true, 
      "title": "Description of the status.", 
      "type": "string"
    }, 
    "full_sync_status": {
      "$ref": "FullSyncStatus, 
      "required": true, 
      "title": "Status of full sync."
    }, 
    "is_data_consistent": {
      "required": true, 
      "title": "Indicates whether the data is consistent. Always returned as true when queried on an active Global Manager node.", 
      "type": "boolean"
    }, 
    "percentage_completed": {
      "required": false, 
      "title": "Percentage estimate of synchronization progress. Ranges from 0 to 100. This value is only returned when queried on an active Global Manager node.", 
      "type": "integer"
    }, 
    "remaining_entries_to_send": {
      "required": false, 
      "title": "Number of entries pending synchronization. This value is only returned when queried on an active Global Manager node.", 
      "type": "integer"
    }, 
    "standby_site": {
      "required": true, 
      "title": "Name of standby site.", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UNAVAILABLE", 
        "ERROR", 
        "ONGOING", 
        "NOT_STARTED"
      ], 
      "required": true, 
      "title": "Status of synchronization between active and standby Global Manager nodes.", 
      "type": "string"
    }, 
    "sync_type": {
      "enum": [
        "UNAVAILABLE", 
        "DELTA_SYNC", 
        "FULL_SYNC"
      ], 
      "required": true, 
      "title": "Type of synchronization currently in effect between active and standby Global Manager nodes.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddALBControllerNodeVMInfo (type)

{
  "description": "Contains a list of Advanced Load Balancer controller node VM deployment requests.", 
  "id": "AddALBControllerNodeVMInfo", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "deployment_requests": {
      "description": "Advanced Load Balancer Controller deployment requests to be deployed by NSX.", 
      "items": {
        "$ref": "ALBControllerNodeVMDeploymentRequest
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of deployment requests", 
      "type": "array"
    }
  }, 
  "title": "Info for AddALBControllerNodeVM", 
  "type": "object"
}

AddClusterNodeAction (type)

{
  "id": "AddClusterNodeAction", 
  "module_id": "ClusterManagement", 
  "properties": {
    "action": {
      "enum": [
        "add_cluster_node"
      ], 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddClusterNodeSpec (type)

{
  "id": "AddClusterNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "controller_role_config": {
      "$ref": "AddControllerNodeSpec
    }, 
    "display_name": {
      "title": "Display name for the node", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": false, 
      "title": "External identifier of the node", 
      "type": "string"
    }, 
    "mgr_role_config": {
      "$ref": "AddManagementNodeSpec
    }
  }, 
  "type": "object"
}

AddClusterNodeVMInfo (type)

{
  "description": "Contains a list of cluster node VM deployment requests and optionally a clustering configuration.", 
  "id": "AddClusterNodeVMInfo", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "clustering_config": {
      "$ref": "ClusteringConfig, 
      "deprecated": true, 
      "description": "This property is deprecated since ClusteringConfig is no longer needed for auto-installation and will be ignored if provided.", 
      "required": false, 
      "title": "Configuration for auto-clustering of VMs post-deployment"
    }, 
    "deployment_requests": {
      "description": "Cluster node VM deployment requests to be deployed by the Manager.", 
      "items": {
        "$ref": "ClusterNodeVMDeploymentRequest
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of deployment requests", 
      "type": "array"
    }
  }, 
  "title": "Info for AddClusterNodeVM", 
  "type": "object"
}

AddControllerNodeSpec (type)

{
  "additionalProperties": false, 
  "id": "AddControllerNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "clustering_params": {
      "$ref": "ClusteringInfo, 
      "description": "The details of the controller node required for cluster initialization or joining to an existing cluster.  If this property is set, the node will be added to an existing cluster or used to create a new cluster.  Otherwise no clustering operation/s will be performed.", 
      "required": false, 
      "title": "Clustering parameters for the node"
    }, 
    "control_plane_server_certificate": {
      "deprecated": true, 
      "description": "Deprecated. Do not supply a value for this property.", 
      "type": "string"
    }, 
    "host_msg_client_info": {
      "$ref": "MsgClientInfo, 
      "required": true
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo, 
      "required": true
    }, 
    "node_id": {
      "description": "Only use this if an id for the node already exists with MP. If not specified, then the node_id will be set to a random id.", 
      "required": false, 
      "title": "Internal identifier of the node", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "AddControllerNodeSpec"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "must be set to AddControllerNodeSpec", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddManagementNodeSpec (type)

{
  "additionalProperties": false, 
  "id": "AddManagementNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cert_thumbprint": {
      "readonly": false, 
      "title": "The certificate thumbprint of the remote node.", 
      "type": "string"
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo
    }, 
    "password": {
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "The password to be used to authenticate with the remote node.", 
      "type": "secure_string"
    }, 
    "remote_address": {
      "$ref": "IPAddress, 
      "readonly": false, 
      "required": true, 
      "title": "The host address of the remote node to which to send this join request."
    }, 
    "type": {
      "enum": [
        "AddManagementNodeSpec"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "must be set to AddManagementNodeSpec", 
      "type": "string"
    }, 
    "user_name": {
      "readonly": false, 
      "required": true, 
      "title": "The username to be used to authenticate with the remote node.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AdditionalSearchParameters (type)

{
  "additionalProperties": false, 
  "description": "This object presents additional search capabilities over any API through free text query string. e.g. query=\"Web-VM-1\".", 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AdditionalSearchParameters", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "dsl": {
      "description": "It's human readable and context-based query language for retreiving information from search indices. For example: Find router where ip is 10.10.1.10", 
      "required": false, 
      "title": "Search DSL (domain specific language) query", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "query": {
      "required": false, 
      "title": "Search query", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Represents search object that provides additional search capabilities", 
  "type": "object"
}

AddressBindingEntry (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "An address binding entry is a combination of the IP-MAC-VLAN binding for a logical port. The address bindings can be obtained via various methods like ARP snooping, DHCP snooping etc. or by user configuration.", 
  "id": "AddressBindingEntry", 
  "module_id": "LogicalPort", 
  "properties": {
    "binding": {
      "$ref": "PacketAddressClassifier, 
      "title": "Combination of IP-MAC-VLAN binding"
    }, 
    "binding_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp at which the binding was discovered via snooping or manually specified by the user", 
      "title": "Timestamp of binding"
    }, 
    "source": {
      "$ref": "AddressBindingSource, 
      "default": "UNKNOWN", 
      "description": "Source from which the address binding entry was obtained", 
      "title": "Address binding source"
    }
  }, 
  "title": "Combination of IP-MAC-VLAN binding", 
  "type": "object"
}

AddressBindingSource (type) (Deprecated)

{
  "deprecated": true, 
  "enum": [
    "INVALID", 
    "UNKNOWN", 
    "USER_DEFINED", 
    "ARP_SNOOPING", 
    "DHCP_SNOOPING", 
    "VM_TOOLS", 
    "ND_SNOOPING", 
    "DHCPV6_SNOOPING", 
    "VM_TOOLS_V6"
  ], 
  "id": "AddressBindingSource", 
  "module_id": "LogicalPort", 
  "title": "Source from which the address binding is obtained", 
  "type": "string"
}

AddressFamilyType (type)

{
  "additionalProperties": false, 
  "enum": [
    "IPV4_UNICAST", 
    "VPNV4_UNICAST", 
    "IPV6_UNICAST", 
    "L2VPN_EVPN"
  ], 
  "id": "AddressFamilyType", 
  "module_id": "Routing", 
  "title": "Type of Address Family", 
  "type": "string"
}

AdvanceClusterRestoreInput (type)

{
  "id": "AdvanceClusterRestoreInput", 
  "module_id": "ClusterRestore", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id of an instruction (as returned by the GET /restore/status\ncall) for which input is to be provided\n", 
      "type": "string"
    }, 
    "resources": {
      "items": {
        "$ref": "SelectableResourceReference
      }, 
      "required": true, 
      "title": "List of resources for which the instruction is applicable.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvanceClusterRestoreRequest (type)

{
  "id": "AdvanceClusterRestoreRequest", 
  "module_id": "ClusterRestore", 
  "properties": {
    "data": {
      "items": {
        "$ref": "AdvanceClusterRestoreInput
      }, 
      "required": true, 
      "title": "List of instructions and their associated data", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvanceServiceConfig (type)

{
  "additionalProperties": false, 
  "description": "Contain optional configuration for deployment.", 
  "id": "AdvanceServiceConfig", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "kubectl_tool": {
      "desciption": "Filename of uploaded Kubernetes tools. Advanced\nconfiguraion option on UI has option to deploy\nKubernetes tools. User need to get this file from\nVMware website. File will contain kubectl binary,\nhelm binary and signature to verify them.\n", 
      "readonly": true, 
      "title": "Filename of uploaded Kubernetes tools", 
      "type": "string"
    }, 
    "messaging_service_name": {
      "description": "FQDN to access kafka messaging service pod.", 
      "title": "Messaging service FQDN", 
      "type": "string"
    }, 
    "service_name": {
      "description": "FQDN to access deployment pod.", 
      "title": "Service FQDN", 
      "type": "string"
    }
  }, 
  "title": "Advanced deployment configuration", 
  "type": "object"
}

AdvertiseRule (type)

{
  "additionalProperties": false, 
  "id": "AdvertiseRule", 
  "module_id": "Routing", 
  "properties": {
    "action": {
      "default": "ALLOW", 
      "description": "ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.", 
      "enum": [
        "DENY", 
        "ALLOW"
      ], 
      "required": false, 
      "title": "Action to ALLOW or DENY advertisement of routes", 
      "type": "string"
    }, 
    "description": {
      "maxLength": 1024, 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "display_name": {
      "maxLength": 255, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "networks": {
      "items": {
        "$ref": "IPCIDRBlock
      }, 
      "required": true, 
      "title": "network(CIDR) to be routed", 
      "type": "array"
    }, 
    "rule_filter": {
      "$ref": "AdvertisementRuleFilter, 
      "required": false, 
      "title": "Rule filter for the advertise rule"
    }
  }, 
  "type": "object"
}

AdvertiseRuleList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AdvertiseRuleList", 
  "module_id": "Routing", 
  "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"
    }, 
    "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"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rules": {
      "default": [], 
      "items": {
        "$ref": "AdvertiseRule
      }, 
      "minItems": 0, 
      "required": false, 
      "title": "List of advertisement rules", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvertisedNetworkCsvRecord (type)

{
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "AdvertisedNetworkCsvRecord", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "network": {
      "description": "Advertised network address.", 
      "readonly": true, 
      "required": true, 
      "title": "Advertised Network", 
      "type": "string"
    }, 
    "rule_filter_type": {
      "description": "Advertised rule filter type", 
      "readonly": true, 
      "required": false, 
      "title": "Advertised rule filter type", 
      "type": "string"
    }, 
    "status": {
      "description": "advertisement status of network to connected gateway SUCCESS - network route successfully plumbed on target gateway DENIED_BY_TARGET_GATEWAY - network denied by target gateway because of in filter rules or missing inter vrf config", 
      "readonly": true, 
      "required": false, 
      "title": "Advertisement status of network", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AdvertisedNetworksListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AdvertisedNetworksListRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Advertised networks list parameters", 
  "type": "object"
}

AdvertisementConfig (type)

{
  "additionalProperties": false, 
  "description": "Advertisement config for different types of routes which need to be advertised from TIER1 logical router to the linked TIER0 logical router", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AdvertisementConfig", 
  "module_id": "Routing", 
  "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"
    }, 
    "advertise_dns_forwarder": {
      "default": false, 
      "description": "Flag to advertise all routes of dns forwarder listener ips and source ips", 
      "required": false, 
      "title": "Advertise dns forwarder ips", 
      "type": "boolean"
    }, 
    "advertise_ipsec_local_ip": {
      "default": false, 
      "description": "Flag to advertise all IPSec VPN local endpoint ips to linked TIER0 logical router", 
      "required": false, 
      "title": "Advertise IPSec VPN local endpoint ips", 
      "type": "boolean"
    }, 
    "advertise_lb_snat_ip": {
      "default": false, 
      "description": "Flag to advertise all lb SNAT ips", 
      "required": false, 
      "title": "Advertise lb SNAT ips", 
      "type": "boolean"
    }, 
    "advertise_lb_vip": {
      "default": false, 
      "description": "Flag to advertise lb vip ips", 
      "required": false, 
      "title": "Advertise lb vip ips", 
      "type": "boolean"
    }, 
    "advertise_nat_routes": {
      "default": false, 
      "description": "Flag to advertise all routes of nat", 
      "required": false, 
      "title": "Advertise NAT routes", 
      "type": "boolean"
    }, 
    "advertise_nsx_connected_routes": {
      "default": false, 
      "description": "Flag to advertise all connected routes", 
      "required": false, 
      "title": "Advertise connected routes", 
      "type": "boolean"
    }, 
    "advertise_static_routes": {
      "default": false, 
      "description": "Flag to advertise all static routes", 
      "required": false, 
      "title": "Advertise static routes", 
      "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"
    }, 
    "enabled": {
      "default": false, 
      "description": "Flag to enable this configuration", 
      "required": false, 
      "title": "Enable advertisement", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "TIER1 logical router id on which to enable this configuration", 
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Advertisement config", 
  "type": "object"
}

AdvertisementRuleFilter (type)

{
  "additionalProperties": false, 
  "description": "To filter the routes advertised by the TIER1 LR to TIER0 LR. Filtering will be based on the type of route and the prefix operator configured.", 
  "id": "AdvertisementRuleFilter", 
  "module_id": "Routing", 
  "properties": {
    "match_route_types": {
      "items": {
        "$ref": "AdvertisementRuleFilterRouteType
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of route types to filter routes", 
      "type": "array"
    }, 
    "prefix_operator": {
      "default": "GE", 
      "description": "GE prefix operator filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.", 
      "enum": [
        "GE", 
        "EQ"
      ], 
      "required": true, 
      "title": "Prefix operator to apply on networks", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AdvertisementRuleFilterRouteType (type)

{
  "additionalProperties": false, 
  "description": "Route types to filter the routes advertised by TIER1 LR. The ANY type filters all routes advertised by TIER1. The STATIC type is deprecated. Please refer to T1_STATIC. The T1_STATIC type filters STATIC routes advertised by TIER1. The NSX_CONNECTED type is deprecated. Please refer to T1_CONNECTED. The T1_CONNECTED type filters directly connected routes including downlink and CSP networks advertised by TIER1. The T1_NAT type filters routes for NAT rules advertised by TIER1. The T1_LB_VIP type filters LB VIP networks advertised by TIER1. The T1_LB_SNAT type filters routes corresponding to LB SNAT rules advertised by TIER1. The T1_DNSFORWARDER type filters routes for DNS FORWARDER advertised by TIER1. The T1_IPSEC_LOCAL_IP type filters IPSec VPN local endpoint ip addresses to be advertised.", 
  "enum": [
    "ANY", 
    "STATIC", 
    "T1_STATIC", 
    "NSX_CONNECTED", 
    "T1_CONNECTED", 
    "T1_NAT", 
    "T1_LB_VIP", 
    "T1_LB_SNAT", 
    "T1_DNSFORWARDER", 
    "T1_IPSEC_LOCAL_IP"
  ], 
  "id": "AdvertisementRuleFilterRouteType", 
  "module_id": "Routing", 
  "title": "Route types to filter TIER1 LR advertised routes", 
  "type": "string"
}

AgentInfo (type)

{
  "additionalProperties": false, 
  "description": "Information on agent download link and install command.", 
  "id": "AgentInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "agent_download_link": {
      "required": false, 
      "title": "Link to Download Agent", 
      "type": "string"
    }, 
    "agent_install_command": {
      "required": false, 
      "title": "Command to Install Agent", 
      "type": "string"
    }, 
    "agent_os_type": {
      "required": false, 
      "title": "Agent OS Type", 
      "type": "string"
    }
  }, 
  "title": "Agent Information", 
  "type": "object"
}

AgentStatus (type)

{
  "id": "AgentStatus", 
  "module_id": "Heatmap", 
  "properties": {
    "name": {
      "enum": [
        "NSX_AGENT", 
        "NSX_OPSAGENT", 
        "NSX_CFGAGENT", 
        "NSX_NESTDB"
      ], 
      "title": "Agent name", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "title": "Agent status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AgentStatusCount (type)

{
  "additionalProperties": false, 
  "id": "AgentStatusCount", 
  "module_id": "Heatmap", 
  "properties": {
    "agents": {
      "description": "List of agent statuses belonging to the transport node", 
      "items": {
        "$ref": "AgentStatus
      }, 
      "title": "NSX agents status", 
      "type": "array"
    }, 
    "down_count": {
      "title": "Down count", 
      "type": "int"
    }, 
    "smartnic_agents": {
      "description": "List of Smartnic agent statuses", 
      "items": {
        "$ref": "SmartnicAgentStatus
      }, 
      "title": "NSX smartnic agents status", 
      "type": "array"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "title": "Roll-up agent status", 
      "type": "string"
    }, 
    "up_count": {
      "title": "Up count", 
      "type": "int"
    }
  }, 
  "type": "object"
}

AggregateDNSForwarderStatistics (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder statistics across enforcement points.", 
  "id": "AggregateDNSForwarderStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }, 
    "statistics_per_enforcement_point": {
      "description": "List of DNS forwarder statistics per enforcement point.", 
      "items": {
        "$ref": "DNSForwarderStatisticsPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder statistics per enforcement point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of DNS forwarder statistics", 
  "type": "object"
}

AggregateDNSForwarderStatus (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder status across enforcement points.", 
  "id": "AggregateDNSForwarderStatus", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }, 
    "status_per_enforcement_point": {
      "description": "List of DNS forwarder status per enforcement point.", 
      "items": {
        "$ref": "DNSForwarderStatusPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder status per enforcement point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of DNS forwarder status", 
  "type": "object"
}

AggregateIPSecVpnSessionStatistics (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of IPSec VPN Session Statistics across Enforcement Points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateIPSecVpnSessionStatistics", 
  "module_id": "PolicyVpnStats", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "List of IPSec VPN Session Statistics per Enforcement Point.", 
      "items": {
        "$ref": "IPSecVpnSessionStatisticsPerEP, 
        "title": "IPSec VPN Session Statistics per Enforcement Point"
      }, 
      "readonly": true, 
      "title": "List of IPSec VPN Session Statistics per Enforcement Point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of IPSec VPN Session Statistics", 
  "type": "object"
}

AggregateIPSecVpnSessionStatus (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of IPSec VPN Session Status across Enforcement Points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateIPSecVpnSessionStatus", 
  "module_id": "PolicyVpnStats", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "List of IPSec VPN Session Status per Enforcement Point.", 
      "items": {
        "$ref": "IPSecVpnSessionStatusPerEP, 
        "title": "IPSec VPN Session Status per Enforcement Point"
      }, 
      "readonly": true, 
      "title": "List of IPSec VPN Session Status per Enforcement Point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of IPSec VPN Session Status", 
  "type": "object"
}

AggregateL2VPNSessionPeerConfig (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of L2VPN Session peer config across Enforcement Points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateL2VPNSessionPeerConfig", 
  "module_id": "PolicyVpnLayer2VPN", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "List of L2VPN Session peer config per Enforcement Point.", 
      "items": {
        "$ref": "L2VPNSessionPeerConfigPerEP
      }, 
      "readonly": true, 
      "title": "List of L2VPN Session Peer config per Enforcement Point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of L2VPN Session Peer Config", 
  "type": "object"
}

AggregateL2VPNSessionStatistics (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of L2VPN Session Statistics across Enforcement Points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateL2VPNSessionStatistics", 
  "module_id": "PolicyVpnStats", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "List of L2VPN Session Statistics per Enforcement Point.", 
      "items": {
        "$ref": "L2VPNSessionStatisticsPerEP, 
        "title": "L2VPN Session Statistics per Enforcement Point"
      }, 
      "readonly": true, 
      "title": "List of L2VPN Session Statistics per Enforcement Point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of L2VPN Session Statistics", 
  "type": "object"
}

AggregateL2VPNSessionStatus (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of L2VPN Session Status across Enforcement Points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateL2VPNSessionStatus", 
  "module_id": "PolicyVpnStats", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "List of L2VPN Session Status per Enforcement Point.", 
      "items": {
        "$ref": "L2VPNSessionStatusPerEP, 
        "title": "L2VPN Session Status per Enforcement Point"
      }, 
      "readonly": true, 
      "title": "List of L2VPN Session Status per Enforcement Point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of L2VPN Session Status", 
  "type": "object"
}

AggregateL2VpnSessionRemoteMac (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of L2Vpn session remote mac across enforcement points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateL2VpnSessionRemoteMac", 
  "module_id": "PolicyVPNStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "l2vpn_session_remote_macs": {
      "descripton": "List of L2Vpn session remote mac per Enforcement Point.\n", 
      "items": {
        "$ref": "L2VpnSessionRemoteMacPerEP
      }, 
      "readonly": true, 
      "title": "List of L2Vpn Session remote mac", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of L2Vpn Session Remote Mac", 
  "type": "object"
}

AggregateLBNodeUsageSummary (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBNodeUsageSummary", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBNodeUsageSummary list results.", 
      "items": {
        "$ref": "LBNodeUsageSummary, 
        "title": "LBNodeUsageSummary"
      }, 
      "readonly": true, 
      "title": "LBNodeUsageSummary list results", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of LBNodeUsageSummary across Enforcement Points.", 
  "type": "object"
}

AggregateLBPoolStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBPoolStatistics", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBPoolStatisticsPerEP list results.", 
      "items": {
        "$ref": "LBPoolStatisticsPerEP, 
        "title": "LBPoolStatisticsPerEP"
      }, 
      "readonly": true, 
      "title": "LBPoolStatisticsPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBPoolStatisticsPerEP", 
  "type": "object"
}

AggregateLBPoolStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBPoolStatus", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBPoolStatusPerEP list results.", 
      "items": {
        "$ref": "LBPoolStatusPerEP, 
        "title": "LBPoolStatusPerEP"
      }, 
      "readonly": true, 
      "title": "LBPoolStatusPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBPoolStatusPerEP", 
  "type": "object"
}

AggregateLBServiceStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBServiceStatistics", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBServiceStatisticsPerEP list results.", 
      "items": {
        "$ref": "LBServiceStatisticsPerEP, 
        "title": "LBServiceStatisticsPerEP"
      }, 
      "readonly": true, 
      "title": "LBServiceStatisticsPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBServiceStatisticsPerEP", 
  "type": "object"
}

AggregateLBServiceStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBServiceStatus", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBServiceStatusPerEP list results.", 
      "items": {
        "$ref": "LBServiceStatusPerEP, 
        "title": "LBServiceStatusPerEP"
      }, 
      "readonly": true, 
      "title": "LBServiceStatusPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBServiceStatusPerEP", 
  "type": "object"
}

AggregateLBServiceUsage (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBServiceUsage", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBServiceUsagePerEP list results.", 
      "items": {
        "$ref": "LBServiceUsagePerEP, 
        "title": "LBServiceUsagePerEP"
      }, 
      "readonly": true, 
      "title": "LBServiceUsagePerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of LBServiceUsagePerEP across Enforcement Points.", 
  "type": "object"
}

AggregateLBVirtualServerStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBVirtualServerStatistics", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBVirtualServerStatisticsPerEP list results.", 
      "items": {
        "$ref": "LBVirtualServerStatisticsPerEP, 
        "title": "LBVirtualServerStatisticsPerEP"
      }, 
      "readonly": true, 
      "title": "LBVirtualServerStatisticsPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBVirtualServerStatisticsPerEP", 
  "type": "object"
}

AggregateLBVirtualServerStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "AggregateLBVirtualServerStatus", 
  "module_id": "PolicyLBStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "results": {
      "description": "LBVirtualServerStatusPerEP list results.", 
      "items": {
        "$ref": "LBVirtualServerStatusPerEP, 
        "title": "LBVirtualServerStatusPerEP"
      }, 
      "readonly": true, 
      "title": "LBVirtualServerStatusPerEP list results", 
      "type": "array"
    }
  }, 
  "title": "Paged Collection of LBVirtualServerStatusPerEP", 
  "type": "object"
}

AggregatePolicyDnsAnswer (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder nslookup answer across enforcement points.", 
  "id": "AggregatePolicyDnsAnswer", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "dns_answer_per_enforcement_point": {
      "description": "List of DNS forwarder nslookup answer per enforcement point.", 
      "items": {
        "$ref": "PolicyDnsAnswerPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder nslookup answer per enforcement point", 
      "type": "array"
    }, 
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }
  }, 
  "title": "Aggregate of DNS forwarder nslookup answer", 
  "type": "object"
}

AggregatePolicyRuntimeInfo (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Aggregate of PolicyRuntimeInfoPerEP across Enforcement Points.", 
  "id": "AggregatePolicyRuntimeInfo", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }
  }, 
  "title": "Aggregate of PolicyRuntimeInfoPerEP", 
  "type": "object"
}

AggregatedDataCounter (type)

{
  "id": "AggregatedDataCounter", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

AggregatedDataCounterEx (type)

{
  "extends": {
    "$ref": "AggregatedDataCounter
  }, 
  "id": "AggregatedDataCounterEx", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

AggregatedFeatureDetailListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AggregatedFeatureDetailListResult", 
  "module_id": "PolicyFeatureFlags", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AggregatedFeatureStateDetails
      }, 
      "required": true, 
      "title": "AggregatedFeatureStateDetail list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of AggregatedFeatureStateDetail", 
  "type": "object"
}

AggregatedFeatureListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AggregatedFeatureListResult", 
  "module_id": "PolicyFeatureFlags", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AggregatedFeatureState
      }, 
      "required": true, 
      "title": "AggregatedFeatureState list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of AggregatedFeatureState", 
  "type": "object"
}

AggregatedFeatureState (type)

{
  "additionalProperties": false, 
  "description": "Feature state aggregating both feature flag and license information", 
  "id": "AggregatedFeatureState", 
  "module_id": "PolicyFeatureFlags", 
  "properties": {
    "feature_name": {
      "required": true, 
      "title": "feature name", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "INCOMPATIBLE", 
        "DISABLED_AND_UNLICENSED", 
        "ENABLED_ONLY", 
        "LICENSED_ONLY", 
        "ENABLED_AND_LICENSED"
      ], 
      "required": true, 
      "title": "Aggregated feature state", 
      "type": "string"
    }
  }, 
  "title": "Aggregated Feature State", 
  "type": "object"
}

AggregatedFeatureStateDetails (type)

{
  "additionalProperties": false, 
  "description": "Feature state aggregating both feature flag and license information including API details", 
  "id": "AggregatedFeatureStateDetails", 
  "module_id": "PolicyFeatureFlags", 
  "properties": {
    "apis": {
      "description": "The list of APIs included in the named feature", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "APIs in feature", 
      "type": "array"
    }, 
    "attributes": {
      "description": "The list of DTO attributes included in the named feature", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "DTO attributes in feature", 
      "type": "array"
    }, 
    "enum_values": {
      "description": "The list of DTO attribute enum values included in the named feature", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "DTO attribute enums in feature", 
      "type": "array"
    }, 
    "feature_name": {
      "required": true, 
      "title": "feature name", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "INCOMPATIBLE", 
        "DISABLED_AND_UNLICENSED", 
        "ENABLED_ONLY", 
        "LICENSED_ONLY", 
        "ENABLED_AND_LICENSED"
      ], 
      "required": true, 
      "title": "Aggregated feature state", 
      "type": "string"
    }
  }, 
  "title": "Aggregated Feature State Details", 
  "type": "object"
}

AggregatedLogicalRouterPortCounters (type)

{
  "id": "AggregatedLogicalRouterPortCounters", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "rx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }, 
    "tx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

Alarm (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Alarm", 
  "module_id": "Monitoring", 
  "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"
    }, 
    "alarm_source": {
      "description": "If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to. If alarm_source_type = ENTITY_ID, this field will contain a list with a single item identifying the entity id that the event instance applies to.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Source identifying entity that the Event instance applies to\n", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "alarm_source_type": {
      "$ref": "AlarmSourceType, 
      "description": "Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID.", 
      "readonly": true, 
      "required": true, 
      "title": "Alarm Source type of the Event"
    }, 
    "description": {
      "description": "Detailed description of Alarm. This is the same detailed description as the corresponding Event identified by feature_name.event_type.", 
      "readonly": true, 
      "required": true, 
      "title": "Detailed description of Alarm", 
      "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"
    }, 
    "entity_id": {
      "description": "The entity that the Event instance applies to. Note entity_id may not be included in a response body. For example, the cpu_high Event may not return an entity_id.", 
      "readonly": true, 
      "title": "The UUID of the entity that the Event instance applies to", 
      "type": "string"
    }, 
    "entity_resource_type": {
      "description": "The entity type that the Event instance applies to.", 
      "readonly": true, 
      "title": "The type of entity that the Event instance applies to", 
      "type": "string"
    }, 
    "event_tags": {
      "description": "Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Tags applicable to the event", 
      "type": "array"
    }, 
    "event_type": {
      "description": "Name of Event, e.g. manager_cpu_usage_high, certificate_expired.", 
      "readonly": true, 
      "required": true, 
      "title": "Name of event", 
      "type": "string"
    }, 
    "event_type_display_name": {
      "description": "Display name of Event type.", 
      "readonly": true, 
      "required": true, 
      "title": "Display name of event type", 
      "type": "string"
    }, 
    "feature_display_name": {
      "description": "Display name of feature defining this Event.", 
      "readonly": true, 
      "required": true, 
      "title": "Display name of feature", 
      "type": "string"
    }, 
    "feature_name": {
      "description": "Feature defining this Event, e.g. manager_health, certificates.", 
      "readonly": true, 
      "required": true, 
      "title": "Feature defining this event", 
      "type": "string"
    }, 
    "id": {
      "description": "ID that uniquely identifies an Alarm.", 
      "readonly": true, 
      "required": true, 
      "title": "ID that uniquely identifies an Alarm", 
      "type": "string"
    }, 
    "kb_article": {
      "description": "KB article link that contains more information on this alarm and recommended actions. Users can refer to the specified link if needed.", 
      "readonly": true, 
      "title": "Link to knowledge base article", 
      "type": "string"
    }, 
    "last_reported_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Indicates when the corresponding Event instance was last reported in milliseconds since epoch.", 
      "readonly": true, 
      "title": "Last reported time of event instance"
    }, 
    "node_display_name": {
      "description": "Display name of node that the event instance applies to.", 
      "readonly": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "description": "The UUID of the node that the Event instance applies to.", 
      "readonly": true, 
      "required": true, 
      "title": "The UUID of the node that the Event instance applies to", 
      "type": "string"
    }, 
    "node_ip_addresses": {
      "description": "IP addresses of node that the event instance applies to.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "IP addresses of node", 
      "type": "array"
    }, 
    "node_resource_type": {
      "description": "The resource type of node that the Event instance applies to eg. ClusterNodeConfig, TransportNode.", 
      "readonly": true, 
      "title": "The resource type of node that the Event instance applies to", 
      "type": "string"
    }, 
    "recommended_action": {
      "description": "Recommended action for Alarm. This is the same action as the corresponding Event identified by feature_name.event_type.", 
      "readonly": true, 
      "required": true, 
      "title": "Recommended action for Alarm", 
      "type": "string"
    }, 
    "reoccurrences_while_suppressed": {
      "description": "The number of reoccurrences since this alarm has been SUPPRESSED.", 
      "readonly": true, 
      "title": "The number of reoccurrences since this alarm has been SUPPRESSED", 
      "type": "integer"
    }, 
    "resolved_by": {
      "description": "User ID of the user that set the status value to RESOLVED. This value can be SYSTEM to indicate that the system resolved the Alarm, for example when the system determines CPU usage is no longer high and the cpu_high Alarm is no longer applicable. This property is only returned when the status value is RESOLVED.", 
      "readonly": true, 
      "title": "User ID of the user that set the status value to RESOLVED", 
      "type": "string"
    }, 
    "resolved_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Indicates when the Alarm was resolved in milliseconds since epoch. This property is only returned when the status value is RESOLVED.", 
      "readonly": true, 
      "title": "Time when Alarm was resolved"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "runtime_data": {
      "description": "Runtime data for Alarm. When an alarming condition occurs, there may be additional data of interest when triaging the underlying issue, for example, output from system commands captured at the time of the error. Note, the contents of this property are not localized.", 
      "readonly": true, 
      "title": "Runtime data for Alarm", 
      "type": "string"
    }, 
    "severity": {
      "$ref": "MonitoringSeverity, 
      "description": "Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.", 
      "readonly": true, 
      "required": true, 
      "title": "Severity of the Alarm"
    }, 
    "status": {
      "$ref": "MonitoringStatus, 
      "description": "Indicate the status which the Alarm is in.", 
      "required": true, 
      "title": "Status of the Alarm"
    }, 
    "summary": {
      "description": "Summary description of Alarm. This is the same summary description as the corresponding Event identified by feature_name.event_type.", 
      "readonly": true, 
      "required": true, 
      "title": "Summary description of Alarm", 
      "type": "string"
    }, 
    "suppress_duration": {
      "description": "The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED. This property is only returned when the status value is SUPPRESSED.", 
      "title": "Duration in hours for which an Alarm is SUPPRESSED", 
      "type": "integer"
    }, 
    "suppress_start_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Indicates when the Alarm was suppressed in milliseconds since epoch. This property is only returned when the status value is SUPPRESSED.", 
      "readonly": true, 
      "title": "Time when Alarm was suppressed"
    }, 
    "suppressed_by": {
      "description": "User ID of the user that set the status value to SUPPRESSED. This property is only returned when the status value is SUPPRESSED.", 
      "readonly": true, 
      "title": "User ID of the user that set the status value to SUPPRESSED", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AlarmFilterParameter (type)

{
  "id": "AlarmFilterParameter", 
  "module_id": "Monitoring", 
  "properties": {
    "after": {
      "$ref": "EpochMsTimestamp, 
      "description": "Filter to fetch alarms after the specified time.", 
      "required": false, 
      "title": "Filter to fetch alarms after the specified time"
    }, 
    "before": {
      "$ref": "EpochMsTimestamp, 
      "description": "Filter to fetch alarms before the specified time.", 
      "required": false, 
      "title": "Filter to fetch alarms before the specified time"
    }, 
    "cursor": {
      "description": "Opaque cursor to be used for getting next page of records (supplied by current result page).", 
      "readonly": false, 
      "required": false, 
      "title": "Cursor for pagination", 
      "type": "string"
    }, 
    "event_tag": {
      "description": "Specify tags for which alarms should be filtered, for example, INFRASTRUCTURE or INTELLIGENCE.", 
      "required": false, 
      "title": "Event tag", 
      "type": "string"
    }, 
    "event_type": {
      "description": "Specify one or more event types for which alarms should be filtered.", 
      "required": false, 
      "title": "Event Type Filter", 
      "type": "string"
    }, 
    "feature_name": {
      "description": "Specify one or more feature names for which alarms should be filtered.", 
      "required": false, 
      "title": "Feature Name", 
      "type": "string"
    }, 
    "id": {
      "description": "Specify one or more alarm IDs for which alarms should be filtered.", 
      "required": false, 
      "title": "Alarm ID", 
      "type": "string"
    }, 
    "intent_path": {
      "description": "Specify one or more intent paths for which alarms should be filtered.", 
      "required": false, 
      "title": "Intent Path for entity ID", 
      "type": "string"
    }, 
    "node_id": {
      "description": "Specify one or more node IDs for which alarms should be filtered.", 
      "required": false, 
      "title": "Node ID", 
      "type": "string"
    }, 
    "node_resource_type": {
      "description": "Specify one or more node resource types for which alarms should be filtered.", 
      "required": false, 
      "title": "Node Resource Type", 
      "type": "string"
    }, 
    "org": {
      "description": "Specify Org ID for which alarms should be filtered.", 
      "required": false, 
      "title": "Org ID", 
      "type": "string"
    }, 
    "page_size": {
      "description": "Maximum number of results to return in this page (server may return fewer).", 
      "required": false, 
      "title": "Page Size for pagination", 
      "type": "integer"
    }, 
    "project": {
      "description": "Specify Project ID for which alarms should be filtered.", 
      "required": false, 
      "title": "Project ID", 
      "type": "string"
    }, 
    "severity": {
      "description": "Specify one or more severity levels for which alarms should be filtered. Must be one of CRITICAL, HIGH, MEDIUM, LOW.", 
      "required": false, 
      "title": "Severity", 
      "type": "string"
    }, 
    "sort_ascending": {
      "default": true, 
      "description": "If true, the value of the column are sorted in ascending order. Otherwise, in descending order.", 
      "required": false, 
      "title": "Represents order of sorting the values", 
      "type": "boolean"
    }, 
    "sort_by": {
      "description": "Sorting on column is based on the sort_by. sort_by represents the field in the output data on which sort is requested.", 
      "required": false, 
      "title": "Key for sorting on this column", 
      "type": "string"
    }, 
    "status": {
      "description": "Specify one or more status for which alarms should be filtered. Must be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.", 
      "required": false, 
      "title": "Status", 
      "type": "string"
    }, 
    "vpc": {
      "description": "Specify VPC ID for which alarms should be filtered.", 
      "required": false, 
      "title": "VPC ID", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter alarms", 
  "type": "object"
}

AlarmSourceType (type)

{
  "enum": [
    "INTENT_PATH", 
    "ENTITY_ID"
  ], 
  "id": "AlarmSourceType", 
  "module_id": "Monitoring", 
  "type": "string"
}

AlarmStatusParameter (type)

{
  "id": "AlarmStatusParameter", 
  "module_id": "Monitoring", 
  "properties": {
    "new_status": {
      "$ref": "MonitoringStatus, 
      "description": "Specify new alarm status for the alarm. Can be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.", 
      "required": true, 
      "title": "Status"
    }, 
    "suppress_duration": {
      "description": "Specify duration in hours for which Alarm should be suppressed.This value must be specified if the new_status is SUPPRESSED.", 
      "title": "Duration in hours for which Alarm should be suppressed", 
      "type": "integer"
    }
  }, 
  "title": "Parameters to update status of alarm", 
  "type": "object"
}

AlarmsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AlarmsListResult", 
  "module_id": "Monitoring", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Alarm
      }, 
      "readonly": true, 
      "title": "List of alarms known to the system", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AlbControllerClusterRuntimeError (type)

{
  "description": "Advanced Load Balancer controller cluster runtime error.", 
  "id": "AlbControllerClusterRuntimeError", 
  "module_id": "PolicyALBControllerDeployment", 
  "properties": {
    "error_code": {
      "description": "Advanced Load Balancer cluster runtime error code.", 
      "readonly": true, 
      "title": "Advanced Load Balancer cluster runtime error code", 
      "type": "int"
    }, 
    "error_message": {
      "description": "Advanced Load Balancer cluster runtime error msg.", 
      "readonly": true, 
      "title": "Advanced Load Balancer cluster runtime error msg", 
      "type": "string"
    }
  }, 
  "title": "Advanced Load Balancer controller cluster runtime error", 
  "type": "object"
}

AlbControllerVsphereClusterNodeVmDeploymentConfig (type)

{
  "description": "The vSphere deployment configuration determines where to deploy the Advanced Load Balancer controller node VM through a vCenter server. It contains settings that are applied during install time. If using DHCP, the following fields must be left unset - management_port_subnets, and default_gateway_addresses", 
  "extends": {
    "$ref": "ALBControllerNodeVMDeploymentConfig
  }, 
  "id": "AlbControllerVsphereClusterNodeVmDeploymentConfig", 
  "module_id": "PolicyALBControllerDeployment", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AlbControllerVsphereClusterNodeVmDeploymentConfig"
  }, 
  "properties": {
    "compute_id": {
      "description": "The Advanced Load Balancer controller node VM will be deployed on the specified cluster or resourcepool for specified VC server.", 
      "required": true, 
      "title": "Cluster identifier or resourcepool identifier", 
      "type": "string"
    }, 
    "default_gateway_addresses": {
      "description": "The default gateway for the VM to be deployed must be specified if all the other VMs it communicates with are not in the same subnet. Do not specify this field and management_port_subnets to use DHCP. Note: only single IPv4 default gateway address is supported and it must belong to management network.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Default gateway for the VM", 
      "type": "array"
    }, 
    "disk_provisioning": {
      "$ref": "DiskProvisioning, 
      "default": "THIN", 
      "description": "Specifies the disk provisioning type of the VM.", 
      "required": false, 
      "title": "Disk provitioning type"
    }, 
    "display_name": {
      "description": "Desired display name for Advanced Load Balancer controller VM to be deployed.", 
      "required": false, 
      "title": "Advanced Load Balancer controller VM display name", 
      "type": "string"
    }, 
    "dns_servers": {
      "description": "List of DNS servers.", 
      "items": {
        "$ref": "IPv4Address
      }, 
      "required": false, 
      "title": "DNS servers.", 
      "type": "array"
    }, 
    "host_id": {
      "description": "The Advanced Load Balancer controller node VM will be deployed on the specified host in the specified VC server within the cluster if host_id is specified. Note: User must ensure that storage and specified networks are accessible by this host.", 
      "required": false, 
      "title": "Host identifier", 
      "type": "string"
    }, 
    "hostname": {
      "description": "Desired host name/FQDN for the VM to be deployed.", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Host name or FQDN for the VM", 
      "type": "string"
    }, 
    "management_network_id": {
      "description": "Distributed portgroup identifier to which the management vnic of Advanced Load Balancer controller node VM will be connected.", 
      "required": true, 
      "title": "Portgroup identifier for management network connectivity", 
      "type": "string"
    }, 
    "management_port_subnets": {
      "description": "IP Address and subnet configuration for the management port. Do not specify this field and default_gateway_addresses to use DHCP. Note: only one IPv4 address is supported for the management port.", 
      "items": {
        "$ref": "IPSubnet
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Port subnets for management port", 
      "type": "array"
    }, 
    "ntp_servers": {
      "description": "List of NTP servers.", 
      "items": {
        "$ref": "HostnameOrIPv4Address
      }, 
      "required": false, 
      "title": "NTP servers.", 
      "type": "array"
    }, 
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the VM.", 
      "enum": [
        "AlbControllerVsphereClusterNodeVmDeploymentConfig"
      ], 
      "required": true, 
      "title": "Type of deployment", 
      "type": "string"
    }, 
    "storage_id": {
      "description": "The Advanced Load Balancer controller node VM will be deployed on the specified datastore in the specified VC server. User must ensure that storage is accessible by the specified cluster/host.", 
      "required": true, 
      "title": "Storage/datastore identifier", 
      "type": "string"
    }, 
    "storage_policy_id": {
      "description": "The cluster node VM will be deployed with the specified storage policy on the specified datastore in the specified VC server. User must ensure that the storage policy is applicable on the given datastore.", 
      "required": false, 
      "title": "Storage policy uuid", 
      "type": "string"
    }, 
    "vc_id": {
      "description": "The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this vCenter server.", 
      "required": true, 
      "title": "vSphere compute identifier for identifying VC server", 
      "type": "string"
    }
  }, 
  "title": "Deployment config on the vSphere platform", 
  "type": "object"
}

AllAccountsStateInfo (type)

{
  "additionalProperties": false, 
  "description": "State Information of all accounts like synchronization in progress count.", 
  "id": "AllAccountsStateInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "sync_in_progress": {
      "description": "Number of cloud accounts for which inventory synchronization is in progress.", 
      "readonly": true, 
      "required": false, 
      "title": "Sync In Progress Count", 
      "type": "integer"
    }
  }, 
  "title": "State Information Of All Accounts", 
  "type": "object"
}

AllAccountsStatistics (type)

{
  "additional_properties": false, 
  "description": "Stores statistics of all accounts managed by CSM.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AllAccountsStatistics", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "accounts_count": {
      "description": "Count of the all accounts managed by CSM.", 
      "readonly": true, 
      "required": false, 
      "title": "Accounts Count", 
      "type": "integer"
    }, 
    "accounts_status": {
      "$ref": "AllAccountsStateInfo, 
      "description": "Status of all accounts like synchronization in progress count.", 
      "readonly": true, 
      "required": false, 
      "title": "Status Of All Accounts"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Instance statistics accross all accounts managed by CSM.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud provider. Legal values are AwsAccount or AzureAccount.", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "All Accounts  Statistics", 
  "type": "object"
}

AllAccountsStatisticsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores statistics for all accounts managed by CSM.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AllAccountsStatisticsListResult", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "decription": "Array of All Accounts Statistics.", 
      "items": {
        "$ref": "AllAccountsStatistics
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "All Accounts Statistics List Result", 
  "type": "object"
}

AllAccountsStatisticsRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter paramters to list all accounts statistics.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AllAccountsStatisticsRequestParameters", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "cloud_type": {
      "description": "Optional identifier for cloud provider based on which all accounts statistics are to be filtered.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud provider. Legal values are AwsAccount or AzureAccount.", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "All Accounts Statistics Request Parameters", 
  "type": "object"
}

AllClusterGroupStatus (type)

{
  "additionalProperties": false, 
  "description": "A list of the statuses of all the groups in the cluster.", 
  "id": "AllClusterGroupStatus", 
  "module_id": "Cluster", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "UUID of the cluster", 
      "type": "string"
    }, 
    "groups": {
      "items": {
        "$ref": "ClusterGroupStatus
      }, 
      "readonly": true, 
      "title": "Array of groups and their statuses", 
      "type": "array"
    }, 
    "overall_status": {
      "enum": [
        "STABLE", 
        "DEGRADED", 
        "UNAVAILABLE"
      ], 
      "readonly": true, 
      "title": "Overall status of the cluster", 
      "type": "string"
    }
  }, 
  "title": "Status of all the cluster groups", 
  "type": "object"
}

AllIdsEventsRequestQueryParameters (type)

{
  "description": "Represents the query parameters, such as the tenancy context, that the ids-events API accepts.", 
  "id": "AllIdsEventsRequestQueryParameters", 
  "module_id": "PolicyIDSMetrics", 
  "properties": {
    "context": {
      "$ref": "TenancyContextQueryParameter
    }
  }, 
  "title": "Query parameters passed to the ids-events API", 
  "type": "object"
}

AllocatedService (type)

{
  "additionalProperties": false, 
  "id": "AllocatedService", 
  "module_id": "EdgeClusters", 
  "properties": {
    "allocation_details": {
      "description": "Additional properties of a service, say the sub_pool_size and sub_pool_type for a LoadBalancer.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "title": "Key-Value map of additional specific properties of services", 
      "type": "array"
    }, 
    "high_availability_status": {
      "description": "Represents the active or the standby state of the service.", 
      "enum": [
        "ACTIVE", 
        "STANDBY", 
        "DOWN", 
        "SYNC", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "HA Status of the service context node", 
      "type": "string"
    }, 
    "service_reference": {
      "$ref": "ResourceReference, 
      "readonly": true, 
      "required": true, 
      "title": "Id and Name of the service context configured on edge node."
    }
  }, 
  "type": "object"
}

AllocationAction (type)

{
  "additionalProperties": false, 
  "id": "AllocationAction", 
  "module_id": "Ipam", 
  "properties": {
    "action": {
      "enum": [
        "ALLOCATE", 
        "RELEASE"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Specifies allocate or release action", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AllocationBasedOnFailureDomain (type)

{
  "additionalProperties": false, 
  "description": "Auto place TIER1 logical routers, DHCP and MDProxy contexts on two edge nodes (active and standby) from different failure domains.", 
  "extends": {
    "$ref": "AllocationRuleAction
  }, 
  "id": "AllocationBasedOnFailureDomain", 
  "module_id": "EdgeClusters", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AllocationBasedOnFailureDomain"
  }, 
  "properties": {
    "action_type": {
      "$ref": "AllocationRuleActionType, 
      "description": "Set action for each allocation rule on edge cluster which will help in auto placement.", 
      "required": true, 
      "title": "Type of action for allocation rule"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains.", 
      "required": false, 
      "title": "Flag to enable failure domain based allocation", 
      "type": "boolean"
    }
  }, 
  "title": "Placement based on failure domain of edge node", 
  "type": "object"
}

AllocationIpAddress (type)

{
  "additionalProperties": false, 
  "description": "Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AllocationIpAddress", 
  "module_id": "Ipam", 
  "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"
    }, 
    "allocation_id": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "title": "Address that is allocated from pool"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AllocationIpAddressListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AllocationIpAddressListResult", 
  "module_id": "Ipam", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AllocationIpAddress
      }, 
      "required": true, 
      "title": "Pool allocation list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AllocationPool (type)

{
  "additionalProperties": false, 
  "id": "AllocationPool", 
  "module_id": "EdgeClusters", 
  "properties": {
    "active_service_count": {
      "description": "Represents the number of acitve services running on the edge node.", 
      "readonly": true, 
      "title": "Number of active services on edge node", 
      "type": "int"
    }, 
    "standby_service_count": {
      "description": "Represents the number of standby services running on the edge node.", 
      "readonly": true, 
      "title": "Number of standby services on edge node", 
      "type": "int"
    }, 
    "sub_pools": {
      "description": "Allocation details of sub-pools configured on edge node.", 
      "items": {
        "$ref": "SubPool
      }, 
      "title": "Edge node sub-pool allocation details", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AllocationPoolType (type)

{
  "additionalProperties": false, 
  "enum": [
    "LoadBalancerAllocationPool"
  ], 
  "id": "AllocationPoolType", 
  "module_id": "LogicalRouter", 
  "title": "Types of logical router allocation pool based on services", 
  "type": "string"
}

AllocationRule (type)

{
  "additionalProperties": false, 
  "description": "Allocation rule on edge cluster which will be considered in auto placement of TIER1 logical routers, DHCP and MDProxy.", 
  "id": "AllocationRule", 
  "module_id": "EdgeClusters", 
  "properties": {
    "action": {
      "$ref": "AllocationRuleAction, 
      "description": "Set action for each allocation rule", 
      "required": true, 
      "title": "Action for allocation rule"
    }
  }, 
  "title": "Allocation rule on edge cluster", 
  "type": "object"
}

AllocationRuleAction (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Define action for each allocation rule which added on edge cluster.", 
  "id": "AllocationRuleAction", 
  "module_id": "EdgeClusters", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "action_type"
  }, 
  "properties": {
    "action_type": {
      "$ref": "AllocationRuleActionType, 
      "description": "Set action for each allocation rule on edge cluster which will help in auto placement.", 
      "required": true, 
      "title": "Type of action for allocation rule"
    }
  }, 
  "title": "Set action for allocation rule", 
  "type": "object"
}

AllocationRuleActionType (type)

{
  "additionalProperties": false, 
  "description": "Set action for each allocation rule on edge cluster which will help in auto placement.", 
  "enum": [
    "AllocationBasedOnFailureDomain"
  ], 
  "id": "AllocationRuleActionType", 
  "module_id": "EdgeClusters", 
  "title": "Type of action for allocation rule", 
  "type": "string"
}

AntreaAdapterStatus (type)

{
  "additionalProperties": false, 
  "id": "AntreaAdapterStatus", 
  "module_id": "PolicyAntreaMonitoring", 
  "properties": {
    "conditions": {
      "description": "Collection of adapter conditions.", 
      "items": {
        "$ref": "ComponentConditionItem
      }, 
      "readonly": true, 
      "title": "Adapter conditions", 
      "type": "array"
    }, 
    "status": {
      "$ref": "ComponentStatus, 
      "description": "Indicate overall healthy status.", 
      "readonly": true, 
      "title": "Antrea adapter status"
    }
  }, 
  "title": "Antrea adapter status", 
  "type": "object"
}

AntreaAgentsInfo (type)

{
  "additionalProperties": false, 
  "id": "AntreaAgentsInfo", 
  "module_id": "PolicyAntreaMonitoring", 
  "properties": {
    "degraded_agent_num": {
      "readonly": true, 
      "title": "The number of degraded agents", 
      "type": "int"
    }, 
    "failed_agent_num": {
      "readonly": true, 
      "title": "The number of failed agents", 
      "type": "int"
    }, 
    "healthy_agent_num": {
      "readonly": true, 
      "title": "The number of healthy agents", 
      "type": "int"
    }
  }, 
  "title": "Antrea agents information", 
  "type": "object"
}

AntreaClusterInfo (type)

{
  "additionalProperties": false, 
  "description": "Antrea cluster status info.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "AntreaClusterInfo", 
  "module_id": "PolicyAntreaMonitoring", 
  "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"
    }, 
    "agent_info": {
      "$ref": "AntreaAgentsInfo, 
      "readonly": true, 
      "title": "Antrea agent info"
    }, 
    "ccp_adapter_status": {
      "$ref": "AntreaAdapterStatus, 
      "description": "Including component status and CCP_ADAPTER_ prefix conditions status.", 
      "readonly": true, 
      "title": "Antrea CCP adapter status"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "controller_status": {
      "$ref": "AntreaControllerStatus, 
      "description": "Including component status, connected agent and CONTROLLER_ prefix conditions status.", 
      "readonly": true, 
      "title": "Antrea Controller status"
    }, 
    "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"
    }, 
    "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"
    }, 
    "mp_adapter_status": {
      "$ref": "AntreaAdapterStatus, 
      "description": "Including component status and MP_ADAPTER_ prefix conditions status.", 
      "readonly": true, 
      "title": "Antrea MP adapter status"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Antrea cluster info", 
  "type": "object"
}

AntreaClusterListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "AntreaClusterListRequestParameters", 
  "module_id": "PolicyAntreaMonitoring", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Antrea cluster list request parameters", 
  "type": "object"
}

AntreaClusterListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged list of Antrea Cluster list.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AntreaClusterListResult", 
  "module_id": "PolicyAntreaMonitoring", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AntreaClusterInfo
      }, 
      "required": true, 
      "title": "Antrea cluster list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Antrea Cluster list", 
  "type": "object"
}

AntreaContainerClusterNode (type)

{
  "id": "AntreaContainerClusterNode", 
  "properties": {
    "cluster_id": {
      "required": true, 
      "title": "The UUID of the container cluster", 
      "type": "string"
    }, 
    "nodes": {
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "title": "List of at most 200 container node UUIDs requiring a support bundle", 
      "type": "array"
    }
  }, 
  "title": "Antrea container cluster and its nodes requiring a support bundle", 
  "type": "object"
}

AntreaControllerStatus (type)

{
  "additionalProperties": false, 
  "description": "Antrea Controller status, including component status, connected agent and CONTROLLER_ prefix conditions status.", 
  "id": "AntreaControllerStatus", 
  "module_id": "PolicyAntreaMonitoring", 
  "properties": {
    "conditions": {
      "description": "Collection of controller related conditions.", 
      "items": {
        "$ref": "ComponentConditionItem
      }, 
      "readonly": true, 
      "title": "Controller conditions", 
      "type": "array"
    }, 
    "connected_agent_num": {
      "description": "If status is UNKNOWN, this number is meaningless.", 
      "readonly": true, 
      "title": "The number of connected agents", 
      "type": "int"
    }, 
    "status": {
      "$ref": "ComponentStatus, 
      "description": "Indicate overall healthy status.", 
      "readonly": true, 
      "title": "Antrea Controller status"
    }
  }, 
  "title": "Antrea Controller status", 
  "type": "object"
}

AntreaHeartbeatConfig (type)

{
  "additionalProperties": false, 
  "description": "Antrea heartbeat configuration for interval time.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "AntreaHeartbeatConfig", 
  "module_id": "PolicyAntreaMonitoring", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "report_interval": {
      "default": 60, 
      "description": "If exceeding 3*report_interval, there is still no heartbeat, cluster status will be UNKNOWN.", 
      "maximum": 600, 
      "minimum": 60, 
      "required": true, 
      "title": "Report interval for Antrea heartbeat with NSX in seconds", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Antrea heartbeat configuration", 
  "type": "object"
}

AntreaHeartbeatConfigListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged list of Antrea Cluster heartbeat config.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AntreaHeartbeatConfigListResult", 
  "module_id": "PolicyAntreaMonitoring", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of Antrea cluster heartbeat config.", 
      "items": {
        "$ref": "AntreaHeartbeatConfig
      }, 
      "required": true, 
      "title": "Antrea cluster heartbeat config list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Antrea Cluster heartbeat config list", 
  "type": "object"
}

AntreaSupportBundleContainerNode (type)

{
  "additionalProperties": {}, 
  "extends": {
    "$ref": "SupportBundleContainerNode
  }, 
  "id": "AntreaSupportBundleContainerNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ANTREA"
  }, 
  "properties": {
    "clusters": {
      "items": {
        "$ref": "AntreaContainerClusterNode
      }, 
      "minItems": 1, 
      "title": "List of AntreaContainerClusterNodes identifying container clusters and their nodes", 
      "type": "array"
    }, 
    "container_type": {
      "enum": [
        "ANTREA"
      ], 
      "required": true, 
      "title": "Support bundle container type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AntreaTraceflowConfig (type)

{
  "additionalProperties": false, 
  "description": "The configuration for Antrea traceflow.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "AntreaTraceflowConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Container cluster ID in inventory. This property is used to identify multiple clusters under single NSX-T.", 
      "required": true, 
      "title": "Container cluster ID", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_external_id": {
      "description": "Destination external id for Antrea traceflow. Must be ContainerApplicationInstance or ContainerApplication. Ignored if destination_ip provided in packet data.", 
      "required": false, 
      "title": "Destination external id", 
      "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"
    }, 
    "is_transient": {
      "default": true, 
      "description": "This field indicates if intent is transient and will be cleaned up by the system if set to true.", 
      "required": false, 
      "title": "Marker to indicate if intent is transient", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "packet": {
      "$ref": "AntreaTraceflowPacketData, 
      "description": "Configuration of packet data.", 
      "required": false, 
      "title": "Packet configuration"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_external_id": {
      "description": "Source external id for Antrea traceflow. Must be ContainerApplicationInstance external_id.", 
      "required": true, 
      "title": "Source external id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Antrea traceflow configuration", 
  "type": "object"
}

AntreaTraceflowConfigListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection for AntreaTraceflowConfigs.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AntreaTraceflowConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AntreaTraceflowConfig
      }, 
      "required": true, 
      "title": "AntreaTraceflowConfig list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of AntreaTraceflowConfigs", 
  "type": "object"
}

AntreaTraceflowIcmpEchoRequestHeader (type)

{
  "description": "IcmpEchoRequest header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowIcmpEchoRequestHeader", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "id": {
      "description": "Id of IcmpEchoRequest.", 
      "title": "IcmpEchoRequest id", 
      "type": "integer"
    }, 
    "sequence": {
      "description": "Sequence number of IcmpEchoRequest.", 
      "title": "Icmp sequence", 
      "type": "integer"
    }
  }, 
  "title": "IcmpEchoHeader for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowIpHeader (type)

{
  "description": "Ip header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowIpHeader", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dstIp": {
      "description": "Destination ip address in IpHeader.", 
      "title": "Destination ip", 
      "type": "string"
    }, 
    "flags": {
      "description": "Protocol setting in IpHeader.", 
      "title": "Flags", 
      "type": "integer"
    }, 
    "protocol": {
      "description": "Protocol setting in IpHeader.", 
      "title": "Protocol", 
      "type": "integer"
    }, 
    "srcIp": {
      "description": "Source ip address in IpHeader.", 
      "title": "Source ip", 
      "type": "string"
    }, 
    "ttl": {
      "description": "TTL value in IpHeader. Default is 64.", 
      "title": "Time to live", 
      "type": "integer"
    }
  }, 
  "title": "IpHeader for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowIpv6Header (type)

{
  "description": "Ipv6 header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowIpv6Header", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dstIp": {
      "description": "Destination ip address in Ipv6Header.", 
      "title": "Destination ip", 
      "type": "string"
    }, 
    "hopLimit": {
      "description": "Hop limit setting in Ipv6Header.", 
      "title": "Hop limit", 
      "type": "integer"
    }, 
    "nextHeader": {
      "description": "Next header setting in Ipv6Header.", 
      "title": "Next header", 
      "type": "integer"
    }, 
    "srcIp": {
      "description": "Source ip address in Ipv6Header.", 
      "title": "Source ip", 
      "type": "string"
    }
  }, 
  "title": "Ipv6Header for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowObservation (type)

{
  "additionalProperties": false, 
  "description": "Observation result for Antrea traceflow.", 
  "id": "AntreaTraceflowObservation", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "component_type": {
      "description": "The type of component.", 
      "enum": [
        "UNKNOWN", 
        "ANTREA_SPOOFGUARD", 
        "ANTREA_LB", 
        "ANTREA_ROUTING", 
        "ANTREA_DFW", 
        "ANTREA_FORWARDING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The component type", 
      "type": "string"
    }, 
    "container_node_id": {
      "description": "UID of the container node that observed a traceflow packet.", 
      "readonly": true, 
      "required": false, 
      "title": "Container node UID", 
      "type": "string"
    }, 
    "observation_type": {
      "description": "The type of observation. AntreaTraceflowObservationDelivered: The packet was delivered to destination Pod properly AntreaTraceflowObservationReceived: The packet was received from another ContainerNode AntreaTraceflowObservationForwarded: The packet was forwarded to next logical node or ContainerNode AntreaTraceflowObservationDropped: The packet was dropped", 
      "enum": [
        "AntreaTraceflowObservationDelivered", 
        "AntreaTraceflowObservationReceived", 
        "AntreaTraceflowObservationForwarded", 
        "AntreaTraceflowObservationDropped"
      ], 
      "required": true, 
      "title": "The observation type", 
      "type": "string"
    }, 
    "timestamp": {
      "description": "Timestamp when the observation was collect by Antrea controller.", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp", 
      "type": "integer"
    }
  }, 
  "title": "Observation for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowObservationListResult (type)

{
  "additionalProperties": false, 
  "description": "List collection for AnteaTraceflowObservation, used in batch API.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AntreaTraceflowObservationListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AntreaTraceflowObservation
      }, 
      "required": false, 
      "title": "AntreaTraceflowObservation list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List object for AnteaTraceflowObservation", 
  "type": "object"
}

AntreaTraceflowPacketData (type)

{
  "description": "Packet data stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowPacketData", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "frameSize": {
      "description": "This property is used to set packet data size.", 
      "title": "Packet frame size", 
      "type": "integer"
    }, 
    "ipHeader": {
      "$ref": "AntreaTraceflowIpHeader, 
      "description": "This property is used to set ipv4 header data.", 
      "title": "Ipv4 header configuration"
    }, 
    "ipv6Header": {
      "$ref": "AntreaTraceflowIpv6Header, 
      "description": "This property is used to set ipv6 header data.", 
      "title": "Ipv6 header configuration"
    }, 
    "payload": {
      "description": "This property is used to set payload data.", 
      "title": "Packet payload", 
      "type": "string"
    }, 
    "resourceType": {
      "description": "This property is used to set resource type.", 
      "enum": [
        "FIELDS_PACKET_DATA", 
        "BINARY_PACKET_DATA"
      ], 
      "title": "Packet resource type", 
      "type": "string"
    }, 
    "transportHeader": {
      "$ref": "AntreaTraceflowTransportHeader, 
      "description": "This property is used to set transport header data.", 
      "title": "Transport header configuration"
    }, 
    "transportType": {
      "description": "This property is used to set transport type.", 
      "enum": [
        "UNICAST", 
        "MULTICAST", 
        "BROADCAST", 
        "UNKNOWN"
      ], 
      "title": "Transport type", 
      "type": "string"
    }
  }, 
  "title": "Packet data for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowStatus (type)

{
  "description": "The status value of one Antrea traceflow.", 
  "id": "AntreaTraceflowStatus", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "phase": {
      "description": "The execution phase of one traceflow.", 
      "enum": [
        "SUCCEEDED", 
        "FAILED"
      ], 
      "title": "Phase", 
      "type": "string"
    }, 
    "reason": {
      "description": "The reason for the failure.", 
      "title": "Reason", 
      "type": "string"
    }
  }, 
  "title": "Status for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowTcpHeader (type)

{
  "description": "Tcp header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowTcpHeader", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dstPort": {
      "description": "Destination port number in TcpHeader.", 
      "title": "Destination port", 
      "type": "integer"
    }, 
    "srcPort": {
      "description": "Source port number in TcpHeader.", 
      "title": "Source port", 
      "type": "integer"
    }, 
    "tcpFlags": {
      "description": "Tcp flags in TcpHeader. SYN flag must be set for traceflow.", 
      "title": "Tcp flags", 
      "type": "integer"
    }
  }, 
  "title": "TcpHeader for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowTransportHeader (type)

{
  "description": "Transport header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowTransportHeader", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "icmpEchoRequestHeader": {
      "$ref": "AntreaTraceflowIcmpEchoRequestHeader, 
      "description": "IcmpEchoRequest header stuffs for Antrea traceflow.", 
      "title": "IcmpEchoRequestHeader for Antrea traceflow"
    }, 
    "tcpHeader": {
      "$ref": "AntreaTraceflowTcpHeader, 
      "description": "Tcp header stuffs for Antrea traceflow.", 
      "title": "TcpHeader for Antrea traceflow"
    }, 
    "udpHeader": {
      "$ref": "AntreaTraceflowUdpHeader, 
      "description": "Udp header stuffs for Antrea traceflow.", 
      "title": "UdpHeader for Antrea traceflow"
    }
  }, 
  "title": "TransportHeader for Antrea traceflow", 
  "type": "object"
}

AntreaTraceflowUdpHeader (type)

{
  "description": "Udp header stuffs for Antrea traceflow.", 
  "id": "AntreaTraceflowUdpHeader", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dstPort": {
      "description": "Destination port number in UdpHeader.", 
      "title": "Destination port", 
      "type": "integer"
    }, 
    "srcPort": {
      "description": "Source port number in UdpHeader.", 
      "title": "Source port", 
      "type": "integer"
    }
  }, 
  "title": "UdpHeader for Antrea traceflow", 
  "type": "object"
}

AphInfo (type)

{
  "additionalProperties": false, 
  "description": "APH information.", 
  "id": "AphInfo", 
  "module_id": "SiteManagerModule", 
  "properties": {
    "address": {
      "required": true, 
      "title": "IP address of APH service", 
      "type": "string"
    }, 
    "certificate": {
      "required": true, 
      "title": "PEM Certificate of APH service", 
      "type": "string"
    }, 
    "fqdn": {
      "required": false, 
      "title": "FQDN, only returned by GET /sites and GET /sites/self", 
      "type": "string"
    }, 
    "node_id": {
      "required": true, 
      "title": "Node ID of the APH service", 
      "type": "string"
    }, 
    "port": {
      "required": true, 
      "title": "Port of APH service", 
      "type": "integer"
    }, 
    "use_fqdn": {
      "required": false, 
      "title": "whether or not fqdn flag is on", 
      "type": "boolean"
    }, 
    "uuid": {
      "required": true, 
      "title": "ID of the APH service", 
      "type": "string"
    }
  }, 
  "title": "Apliance proxy hub information", 
  "type": "object"
}

ApiError (type)

{
  "extends": {
    "$ref": "RelatedApiError
  }, 
  "id": "ApiError", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }, 
    "related_errors": {
      "items": {
        "$ref": "RelatedApiError
      }, 
      "title": "Other errors related to this error", 
      "type": "array"
    }
  }, 
  "title": "Detailed information about an API Error", 
  "type": "object"
}

ApiRequestBody (type)

{
  "additionalProperties": false, 
  "description": "API Request Body is an Event Source that represents an API request body that is being reveived as part of an API. Supported Request Bodies are those received as part of a PATCH/PUT/POST request.", 
  "extends": {
    "$ref": "Source
  }, 
  "id": "ApiRequestBody", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ApiRequestBody"
  }, 
  "properties": {
    "resource_pointer": {
      "description": "Regex path representing a regex expression on resources. This regex is used to identify the request body(ies) that is/are the source of the Event. For instance: specifying \"Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default\" as a source means that ANY resource starting with Lb or ANY resource with \"/infra/tier-0s/vmc/ipsec-vpn-services/default\" as path would be the source of the event in question.", 
      "required": true, 
      "title": "Resource Pointer", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Event Source resource type.", 
      "enum": [
        "ResourceOperation", 
        "ApiRequestBody"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "API Request Body", 
  "type": "object"
}

ApiServiceConfig (type)

{
  "additionalProperties": false, 
  "description": "Properties that affect the configuration of the NSX API service.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ApiServiceConfig", 
  "module_id": "ApiServiceConfig", 
  "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"
    }, 
    "basic_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether basic authentication is enabled or disabled in API calls.", 
      "title": "Enable or disable basic authentication", 
      "type": "boolean"
    }, 
    "cipher_suites": {
      "description": "The TLS cipher suites that the API service will negotiate.", 
      "items": {
        "$ref": "CipherSuite
      }, 
      "minItems": 1, 
      "title": "Cipher suites used to secure contents of connection", 
      "type": "array"
    }, 
    "client_api_concurrency_limit": {
      "default": 40, 
      "description": "The maximum number of concurrent API requests that will be serviced for a given authenticated client.  If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls", 
      "type": "integer"
    }, 
    "client_api_rate_limit": {
      "default": 100, 
      "description": "The maximum number of API requests that will be serviced per second for a given authenticated client.  If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls per second", 
      "type": "integer"
    }, 
    "connection_timeout": {
      "default": 30, 
      "description": "NSX connection timeout, in seconds. To disable timeout, set to 0.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout", 
      "type": "integer"
    }, 
    "cookie_based_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.", 
      "title": "Enable or disable cookie-based authentication", 
      "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"
    }, 
    "global_api_concurrency_limit": {
      "default": 199, 
      "description": "The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client.  To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Global API rate limit in calls", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lockout_immune_addresses": {
      "description": "The list of IP addresses which are not subjected to a lockout on failed login attempts.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "title": "IP addresses which are not subject to lockout on failed login attempts", 
      "type": "array"
    }, 
    "protocol_versions": {
      "description": "The TLS protocol versions that the API service will negotiate.", 
      "items": {
        "$ref": "ProtocolVersion
      }, 
      "minItems": 1, 
      "title": "TLS protocol versions", 
      "type": "array"
    }, 
    "redirect_host": {
      "$ref": "HostnameOrIPv4AddressOrEmptyString, 
      "default": "", 
      "description": "Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (\"\").", 
      "title": "Hostname/IP to use in redirect headers"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "session_timeout": {
      "default": 1800, 
      "descriptions": "Sessions inactive for more than this value are terminated. The value is given in seconds. Set to 0 to disable timeouts.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX session inactivity timeout", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Configuration of the API service", 
  "type": "object"
}

ApplianceLatencyData (type)

{
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ApplianceLatencyData", 
  "module_id": "ShaApplianceMonitor", 
  "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"
    }, 
    "id": {
      "description": "Display the Appliance id.", 
      "title": "Appliance id", 
      "type": "string"
    }, 
    "latency_data": {
      "description": "Latency Data list.", 
      "items": {
        "$ref": "ApplianceLatencyDataItem
      }, 
      "title": "Latency Data List", 
      "type": "array"
    }, 
    "name": {
      "description": "Display the appliance name.", 
      "title": "Appliance name", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp of last modification.", 
      "title": "Timestamp of last modification"
    }
  }, 
  "title": "Display the latency data by given appliance node", 
  "type": "object"
}

ApplianceLatencyDataItem (type)

{
  "description": "Describes appliance latency data in detail.", 
  "id": "ApplianceLatencyDataItem", 
  "module_id": "ShaApplianceMonitor", 
  "properties": {
    "destination_node_id": {
      "description": "Display the appliance node id.", 
      "title": "Node id", 
      "type": "string"
    }, 
    "destination_node_ip": {
      "description": "Display the appliance node ip.", 
      "title": "Node name", 
      "type": "string"
    }, 
    "destination_node_name": {
      "description": "Display the appliance node name.", 
      "title": "Node name", 
      "type": "string"
    }, 
    "packet_loss_percent": {
      "description": "Display the percentage of lost packet.", 
      "title": "Display the percentage of lost packet", 
      "type": "string"
    }, 
    "packet_received": {
      "description": "Display the received packets.", 
      "title": "Display the received packets", 
      "type": "integer"
    }, 
    "packet_transmitted": {
      "description": "Display the transmitted packets in Ping", 
      "title": "Display the transmitted packets", 
      "type": "integer"
    }, 
    "rtt_avg": {
      "description": "Display the average Round Trip Time in milliseconds.", 
      "title": "Display the average rtt of latency value", 
      "type": "number"
    }, 
    "rtt_max": {
      "description": "Display the max Round Trip Time in milliseconds.", 
      "title": "Display the max rtt of latency value", 
      "type": "number"
    }, 
    "rtt_mdev": {
      "description": "Display the mean Round Trip Time in milliseconds.", 
      "title": "Display the mean rtt of latency value", 
      "type": "number"
    }, 
    "rtt_min": {
      "description": "Display the min Round Trip Time in milliseconds.", 
      "title": "Display the min rtt of latency value", 
      "type": "number"
    }, 
    "source_node_ip": {
      "description": "Display the appliance node ip.", 
      "title": "Node name", 
      "type": "string"
    }, 
    "status": {
      "description": "Display the connection status between source node and destination node.", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Display the connection status", 
      "type": "string"
    }, 
    "total_time": {
      "description": "Display the total time of sending and receiving packets in milliseconds.", 
      "title": "Display the total time in milliseconds", 
      "type": "integer"
    }
  }, 
  "title": "Appliance Latency data", 
  "type": "object"
}

ApplianceLatencyListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ApplianceLatencyListResult", 
  "module_id": "ShaApplianceMonitor", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "required": true, 
      "title": "Total appliance latency count", 
      "type": "integer"
    }, 
    "results": {
      "description": "Display the appliance latency data list.", 
      "items": {
        "$ref": "ApplianceLatencyData
      }, 
      "title": "Appliance Process List", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of process data", 
  "type": "object"
}

ApplianceManagementSuppressRedirectQueryParameter (type)

{
  "additionalProperties": false, 
  "id": "ApplianceManagementSuppressRedirectQueryParameter", 
  "properties": {
    "suppress_redirect": {
      "default": false, 
      "description": "Do not return a redirect HTTP status.", 
      "title": "Suppress redirect status if applicable", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ApplianceManagementTaskListResult", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ApplianceManagementTaskProperties
      }, 
      "required": true, 
      "title": "Task property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task query results", 
  "type": "object"
}

ApplianceManagementTaskProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ApplianceManagementTaskProperties", 
  "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"
    }, 
    "async_response_available": {
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "title": "Details about the task if known", 
      "type": "object"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "id": {
      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "ApplianceManagementTaskStatus, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task properties", 
  "type": "object"
}

ApplianceManagementTaskQueryParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters
  }, 
  "id": "ApplianceManagementTaskQueryParameters", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "request_method": {
      "description": "Comma-separated request methods to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request method(s) to include in query result", 
      "type": "string"
    }, 
    "request_path": {
      "description": "Comma-separated request paths to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI path(s) to include in query result", 
      "type": "string"
    }, 
    "request_uri": {
      "description": "Comma-separated request URIs to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI(s) to include in query result", 
      "type": "string"
    }, 
    "status": {
      "description": "Comma-separated status values to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Status(es) to include in query result", 
      "type": "string"
    }, 
    "user": {
      "description": "Comma-separated user names to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Names of users to include in query result", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskStatus (type)

{
  "enum": [
    "running", 
    "error", 
    "success", 
    "canceling", 
    "canceled", 
    "killed"
  ], 
  "id": "ApplianceManagementTaskStatus", 
  "title": "Current status of the appliance management task", 
  "type": "string"
}

ApplianceProcessData (type)

{
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ApplianceProcessData", 
  "module_id": "ShaApplianceMonitor", 
  "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"
    }, 
    "id": {
      "description": "Display the Appliance id.", 
      "title": "Appliance id", 
      "type": "string"
    }, 
    "name": {
      "description": "Display the appliance name.", 
      "title": "Appliance name", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp of last modification.", 
      "title": "Timestamp of last modification"
    }, 
    "top_process_by_cpu_count": {
      "description": "Display the total count of process.", 
      "title": "Process count", 
      "type": "integer"
    }, 
    "top_process_by_cpu_list": {
      "description": "Display the top process list by CPU.", 
      "items": {
        "$ref": "ProcessInformation
      }, 
      "title": "Top process list by CPU", 
      "type": "array"
    }, 
    "top_process_by_mem_count": {
      "description": "Display the total count of process.", 
      "title": "Process count", 
      "type": "integer"
    }, 
    "top_process_by_mem_list": {
      "description": "Display the top process list by memory.", 
      "items": {
        "$ref": "ProcessInformation
      }, 
      "title": "Top process list by memory", 
      "type": "array"
    }
  }, 
  "title": "List of process data in given appliance node", 
  "type": "object"
}

ApplianceProcessListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ApplianceProcessListResult", 
  "module_id": "ShaApplianceMonitor", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Display the appliance process list.", 
      "items": {
        "$ref": "ApplianceProcessData
      }, 
      "title": "Appliance Process List", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of process data", 
  "type": "object"
}

ApplicationConnectivityStrategy (type)

{
  "additionalProperties": false, 
  "description": "Allows more granular policies for application workloads", 
  "id": "ApplicationConnectivityStrategy", 
  "module_id": "Policy", 
  "properties": {
    "application_connectivity_strategy": {
      "description": "App connectivity strategies", 
      "enum": [
        "ALLOW_INTRA", 
        "ALLOW_EGRESS", 
        "ALLOW_INGRESS", 
        "DROP_INGRESS", 
        "DROP_EGRESS"
      ], 
      "required": true, 
      "title": "Application connectivity strategy", 
      "type": "string"
    }, 
    "default_application_rule_id": {
      "description": "Based on the value of the app connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule ID associated with the application_connectivity_strategy", 
      "type": "integer"
    }, 
    "logging_enabled": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }
  }, 
  "title": "Application specific connectivity strategy", 
  "type": "object"
}

ApplicationProfileType (type)

{
  "additionalProperties": false, 
  "description": "An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or LbFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LbHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LbHttpProfile is intended to simplify enabling certain common use cases. LbHttpProfile is deprecated as NSX-T Load Balancer is deprecated.", 
  "enum": [
    "LbHttpProfile", 
    "LbFastTcpProfile", 
    "LbFastUdpProfile"
  ], 
  "id": "ApplicationProfileType", 
  "module_id": "LoadBalancer", 
  "title": "application profile type", 
  "type": "string"
}

AppliedTos (type)

{
  "description": "Entity lists where the profile will be enabled on.", 
  "id": "AppliedTos", 
  "module_id": "UpmCommon", 
  "properties": {
    "logical_ports": {
      "items": {
        "$ref": "ResourceReference
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Logical Port List", 
      "type": "array"
    }, 
    "logical_switches": {
      "items": {
        "$ref": "ResourceReference
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Logical Switch List", 
      "type": "array"
    }, 
    "nsgroups": {
      "items": {
        "$ref": "ResourceReference
      }, 
      "nsx_feature": "UnifiedProfileManagementSupportNSGroup", 
      "readonly": false, 
      "required": false, 
      "title": "NSGroup List", 
      "type": "array"
    }
  }, 
  "title": "Entities Applied to Profile", 
  "type": "object"
}

ApplyCertificateParameters (type)

{
  "additionalProperties": false, 
  "id": "ApplyCertificateParameters", 
  "module_id": "CertificateManager", 
  "properties": {
    "node_id": {
      "description": "Optional node-id to which to apply the certificate. The cluster_certificate field of the matching Certificate Profile must be false, as those get applied to all nodes.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Node Id", 
      "type": "string"
    }, 
    "service_type": {
      "$ref": "ServiceType, 
      "description": "Service Type of the CertificateProfile to apply the certificate to.", 
      "required": true, 
      "title": "Service Type"
    }
  }, 
  "type": "object"
}

ArpHeader (type)

{
  "additionalProperties": false, 
  "id": "ArpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_ip": {
      "$ref": "IPv4Address, 
      "required": true, 
      "title": "The destination IP address"
    }, 
    "op_code": {
      "default": "ARP_REQUEST", 
      "description": "This field specifies the nature of the Arp message being sent.", 
      "enum": [
        "ARP_REQUEST", 
        "ARP_REPLY"
      ], 
      "required": true, 
      "title": "Arp message type", 
      "type": "string"
    }, 
    "src_ip": {
      "$ref": "IPv4Address, 
      "description": "This field specifies the IP address of the sender. If omitted, the src_ip is set to 0.0.0.0.", 
      "required": false, 
      "title": "The source IP address"
    }
  }, 
  "type": "object"
}

ArpSnoopingConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains ARP snooping related configuration.", 
  "id": "ArpSnoopingConfig", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "arp_binding_limit": {
      "default": 1, 
      "description": "Number of arp snooped IP addresses Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum number of ARP bindings", 
      "type": "int"
    }, 
    "arp_snooping_enabled": {
      "default": true, 
      "description": "Indicates whether ARP snooping is enabled", 
      "required": false, 
      "title": "Is ARP snooping enabled or not", 
      "type": "boolean"
    }
  }, 
  "title": "ARP Snooping Configuration", 
  "type": "object"
}

ArpTableRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseEdgeStatisticsRequestParameters
  }, 
  "id": "ArpTableRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "host_transport_node_path": {
      "description": "Policy path of host transport node. In case of API used from Global Manager, use the HostTransportNode path from Local Manager.", 
      "title": "Policy path of host transport node", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

AssignedByDhcp (type) (Deprecated)

{
  "deprecated": true, 
  "description": "This type can be specified in ip assignment spec of host switch if DHCP based IP assignment is desired for host switch virtual tunnel endpoints.", 
  "extends": {
    "$ref": "IpAssignmentSpec
  }, 
  "id": "AssignedByDhcp", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AssignedByDhcp"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec", 
        "None"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DHCP based IP assignment.", 
  "type": "object"
}

AssociatedKubernetesClusterListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "List request params for the api that get associated clusters of a given group.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "AssociatedKubernetesClusterListRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Associated kubernetes clusters list request params", 
  "type": "object"
}

AssociationListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AssociationListRequestParameters", 
  "module_id": "Association", 
  "properties": {
    "associated_resource_type": {
      "$ref": "AssociationTargetType, 
      "required": true, 
      "title": "Type of the associated resources"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "fetch_ancestors": {
      "default": false, 
      "description": "If set to true, will fetch direct as well as indirect(considering containment as well as nesting) associated objects for the given source Id.", 
      "required": false, 
      "title": "Fetch complete list of associated resources considering\ncontainment and nesting\n", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_id": {
      "required": true, 
      "title": "The resource for which associated resources are to be fetched", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "AssociationSourceType, 
      "required": true, 
      "title": "Type of the resource for which associated resources are to be fetched"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Association list request parameters", 
  "type": "object"
}

AssociationListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AssociationListResult", 
  "module_id": "Association", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ResourceReference
      }, 
      "required": true, 
      "title": "Paged Collection of ResourceReference", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AssociationSourceType (type)

{
  "enum": [
    "NSGroup", 
    "IPSet", 
    "MACSet", 
    "LogicalSwitch", 
    "LogicalPort", 
    "VirtualMachine", 
    "DirectoryGroup", 
    "VirtualNetworkInterface", 
    "TransportNode", 
    "IPAddress", 
    "CloudNativeServiceInstance", 
    "PhysicalServer"
  ], 
  "id": "AssociationSourceType", 
  "module_id": "Association", 
  "title": "Resource type valid for use as source in association API", 
  "type": "string"
}

AssociationTargetType (type)

{
  "enum": [
    "NSGroup"
  ], 
  "id": "AssociationTargetType", 
  "module_id": "Association", 
  "title": "Resource type valid for use as target in association API", 
  "type": "string"
}

AttachedInterface (type) (Deprecated)

{
  "deprecated": true, 
  "description": "The Attached interface is only effective for the port on Bare metal server.", 
  "id": "AttachedInterface", 
  "module_id": "LogicalPort", 
  "properties": {
    "app_intf_name": {
      "required": true, 
      "title": "The name of application interface", 
      "type": "string"
    }, 
    "default_gateway": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "Gateway IP"
    }, 
    "migrate_intf": {
      "description": "IP configuration on migrate_intf will migrate to app_intf_name. It is used for Management and Application sharing the same IP.", 
      "required": false, 
      "title": "Interface name to migrate", 
      "type": "string"
    }, 
    "routing_table": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Routing rules", 
      "type": "array"
    }
  }, 
  "title": "Attached interface specification for Bare metal server", 
  "type": "object"
}

AttachedInterfaceEntry (type)

{
  "additionalProperties": false, 
  "description": "The Attached interface is only effective for the segment port on Bare metal server.", 
  "id": "AttachedInterfaceEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "app_intf_name": {
      "required": true, 
      "title": "The name of application interface", 
      "type": "string"
    }, 
    "default_gateway": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "Gateway IP"
    }, 
    "migrate_intf": {
      "description": "IP configuration on migrate_intf will migrate to app_intf_name. It is used for Management and Application sharing the same IP.", 
      "required": false, 
      "title": "Interface name to migrate", 
      "type": "string"
    }, 
    "routing_table": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Routing rules", 
      "type": "array"
    }
  }, 
  "title": "Attached interface information for Bare metal server", 
  "type": "object"
}

AttachmentContext (type) (Deprecated)

{
  "abstract": true, 
  "deprecated": true, 
  "id": "AttachmentContext", 
  "module_id": "LogicalPort", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "allocate_addresses": {
      "enum": [
        "IpPool", 
        "MacPool", 
        "Both", 
        "None", 
        "Dhcp", 
        "DhcpV6", 
        "SLAAC"
      ], 
      "required": false, 
      "title": "A flag to indicate whether to allocate addresses from allocation\n    pools bound to the parent logical switch.\n", 
      "type": "string"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'VifAttachmentContext' or 'L2VpnAttachmentContext'\n", 
      "required": true, 
      "title": "Used to identify which concrete class it is", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AttachmentType (type) (Deprecated)

{
  "deprecated": true, 
  "enum": [
    "VIF", 
    "LOGICALROUTER", 
    "BRIDGEENDPOINT", 
    "DHCP_SERVICE", 
    "METADATA_PROXY", 
    "L2VPN_SESSION", 
    "L2FORWARDER"
  ], 
  "id": "AttachmentType", 
  "module_id": "LogicalPort", 
  "title": "Type of attachment for logical port.", 
  "type": "string"
}

AttachmentTypeQueryString (type) (Deprecated)

{
  "deprecated": true, 
  "enum": [
    "VIF", 
    "LOGICALROUTER", 
    "BRIDGEENDPOINT", 
    "DHCP_SERVICE", 
    "METADATA_PROXY", 
    "L2VPN_SESSION", 
    "NONE"
  ], 
  "id": "AttachmentTypeQueryString", 
  "module_id": "LogicalPort", 
  "title": "Type of attachment for logical port; for query only.", 
  "type": "string"
}

Attribute (type)

{
  "description": "Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.", 
  "id": "Attribute", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "attribute_type": {
      "description": "Attribute Type can be of any of the allowed enum type.", 
      "enum": [
        "IP_ADDRESS", 
        "PORT", 
        "PASSWORD", 
        "STRING", 
        "LONG", 
        "BOOLEAN"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Attributetype.", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Attribute display name string value.", 
      "readonly": false, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "key": {
      "description": "Attribute key string value.", 
      "readonly": false, 
      "required": true, 
      "title": "key", 
      "type": "string"
    }, 
    "read_only": {
      "default": false, 
      "description": "Read only Attribute cannot be overdidden by service instance/deployment.", 
      "readonly": false, 
      "required": false, 
      "title": "read only", 
      "type": "boolean"
    }, 
    "value": {
      "description": "Attribute value string value.", 
      "readonly": false, 
      "required": false, 
      "title": "value", 
      "type": "string"
    }
  }, 
  "title": "Attributes", 
  "type": "object"
}

AttributeVal (type)

{
  "description": "Contains type specific properties of generic realized entity", 
  "id": "AttributeVal", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "data_type": {
      "description": "Datatype of the property", 
      "enum": [
        "STRING", 
        "DATE", 
        "INTEGER", 
        "BOOLEAN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Datatype of property represented by this attribute", 
      "type": "string"
    }, 
    "key": {
      "description": "Attribute key", 
      "required": false, 
      "title": "Key for the attribute value", 
      "type": "string"
    }, 
    "multivalue": {
      "description": "If attribute has a single value or collection of values", 
      "readonly": true, 
      "title": "multivalue flag", 
      "type": "boolean"
    }, 
    "values": {
      "description": "List of attribute values", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of values for the attribute", 
      "type": "array"
    }
  }, 
  "title": "Attribute values of realized type", 
  "type": "object"
}

AuditLog (type)

{
  "additionalProperties": false, 
  "id": "AuditLog", 
  "properties": {
    "appname": {
      "required": true, 
      "title": "Application name field of the log", 
      "type": "string"
    }, 
    "facility": {
      "required": true, 
      "title": "Facility field of the log", 
      "type": "integer"
    }, 
    "full_log": {
      "required": true, 
      "title": "Full log with both header and message", 
      "type": "string"
    }, 
    "hostname": {
      "required": true, 
      "title": "Hostname field of the log", 
      "type": "string"
    }, 
    "message": {
      "required": true, 
      "title": "Message field of the log", 
      "type": "string"
    }, 
    "msgid": {
      "required": true, 
      "title": "Message ID field of the log", 
      "type": "string"
    }, 
    "priority": {
      "required": true, 
      "title": "Priority field of the log", 
      "type": "integer"
    }, 
    "procid": {
      "required": true, 
      "title": "Process ID field of the log", 
      "type": "integer"
    }, 
    "struct_data": {
      "$ref": "StructuredData, 
      "required": true, 
      "title": "Structured data field of the log"
    }, 
    "timestamp": {
      "required": true, 
      "title": "Date and time in UTC of the log", 
      "type": "string"
    }
  }, 
  "title": "Audit log in RFC5424 format", 
  "type": "object"
}

AuditLogListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AuditLogListResult", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_full_sync_timestamp": {
      "required": true, 
      "title": "Timestamp of the last full audit log collection", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AuditLog
      }, 
      "required": true, 
      "title": "Audit log results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Audit log collection results", 
  "type": "object"
}

AuditLogQueryParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters
  }, 
  "id": "AuditLogQueryParameters", 
  "properties": {
    "cursor": {
      "description": "A log cursor points to a specific line number in the master audit log", 
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "integer"
    }, 
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "page_size": {
      "default": 100, 
      "description": "The page size determines the number of logs to be returned", 
      "maximum": 100, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

AuditLogRequest (type)

{
  "additionalProperties": false, 
  "id": "AuditLogRequest", 
  "properties": {
    "log_age_limit": {
      "minimum": 0, 
      "title": "Include logs with timstamps not past the age limit in days", 
      "type": "integer"
    }, 
    "log_filter": {
      "required": false, 
      "title": "Audit logs should meet the filter condition", 
      "type": "string"
    }, 
    "log_filter_type": {
      "default": "TEXT", 
      "enum": [
        "TEXT", 
        "REGEX"
      ], 
      "title": "Type of log filter", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AuthServiceProperties (type)

{
  "id": "AuthServiceProperties", 
  "properties": {
    "logging_level": {
      "default": "INFO", 
      "enum": [
        "OFF", 
        "FATAL", 
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "required": false, 
      "title": "Service logging level", 
      "type": "string"
    }
  }, 
  "title": "Auth Service properties", 
  "type": "object"
}

AuthenticationPolicyProperties (type)

{
  "additionalProperties": {}, 
  "extends": {
    "$ref": "PasswordComplexityProperties
  }, 
  "id": "AuthenticationPolicyProperties", 
  "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"
    }, 
    "_retry_prompt": {
      "default": 3, 
      "readonly": true, 
      "title": "Prompt user at most N times before returning with error.", 
      "type": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "api_failed_auth_lockout_period": {
      "default": 900, 
      "description": "Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "api_failed_auth_reset_period": {
      "default": 900, 
      "description": "In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Period, in seconds, for authentication failures to trigger lockout", 
      "type": "integer"
    }, 
    "api_max_auth_failures": {
      "default": 5, 
      "description": "Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger API lockout", 
      "type": "integer"
    }, 
    "cli_failed_auth_lockout_period": {
      "default": 900, 
      "description": "Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "cli_max_auth_failures": {
      "default": 5, 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger CLI lockout", 
      "type": "integer"
    }, 
    "digits": {
      "default": -1, 
      "description": "Number of digits (0..9) expected in user password. <p>N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.</p> <p>N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> digits.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 digit is required for a new password.", 
      "maximum": 128, 
      "minimum": -128, 
      "title": "Number of digits in password", 
      "type": "integer"
    }, 
    "hash_algorithm": {
      "default": "sha512", 
      "description": "Sets hash/cryptographic algorithm type for new passwords.", 
      "enum": [
        "sha512", 
        "sha256"
      ], 
      "title": "Hash algorithm", 
      "type": "string"
    }, 
    "lower_chars": {
      "default": -1, 
      "description": "Number of lower case characters (a..z) expected in user password. <p>N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> lower case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 lower case character is required for a new password.", 
      "maximum": 128, 
      "minimum": -128, 
      "title": "Number of lower-case characters in password", 
      "type": "integer"
    }, 
    "max_repeats": {
      "default": 0, 
      "description": "Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0.", 
      "maximum": 128, 
      "minimum": 0, 
      "title": "Number of same consecutive characters", 
      "type": "integer"
    }, 
    "max_sequence": {
      "default": 0, 
      "description": "Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0.", 
      "maximum": 128, 
      "minimum": 0, 
      "title": "Length of permissible monotonic sequence in password substring", 
      "type": "integer"
    }, 
    "maximum_password_length": {
      "default": 128, 
      "description": "Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters.", 
      "maximum": 128, 
      "minimum": 8, 
      "title": "Maximum password length", 
      "type": "integer"
    }, 
    "minimum_password_length": {
      "default": 12, 
      "description": "Minimum number of characters expected in password; user can not set their password of length less than this parameter.<br /> NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above - <p>if existing appliance is configured with <code>minimum_password_length</code> less than current default value, then upgraded appliance will reset the configured setting back to recommended default; which can be explicitly modified back to original value or any other integer greater than or equal to supported minimum value.</p> <p>VMware recommends to set strong passwords for systems and appliances, further suggests to maintain strong <code>minimum_password_length</code> value. NSX resets this value to default and recommends to maintain upgraded default value or above for password complexity requirement.</p> <p>If any existing user passwords are set with length of less than newly configured <code>minimum_password_length</code>, then its recommended to reset the user passwords as per newly configured password complexity compliance.</p> <p>If existing <code>minimum_password_length</code> is greater than or equal to default value, which shall be retained as it is in newly upgraded appliance.</p> By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed.", 
      "maximum": 128, 
      "minimum": 8, 
      "title": "Minimum password length", 
      "type": "integer"
    }, 
    "minimum_unique_chars": {
      "default": 0, 
      "description": "Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0.", 
      "maximum": 128, 
      "minimum": 0, 
      "title": "Number of unique characters from old password", 
      "type": "integer"
    }, 
    "password_remembrance": {
      "default": 0, 
      "description": "Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0.", 
      "minimum": 0, 
      "title": "Password remembrance from previous generations", 
      "type": "integer"
    }, 
    "special_chars": {
      "default": -1, 
      "description": "Number of special characters (!@#$&*..) expected in user password. <p>N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> special case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 special character is required for a new password.", 
      "maximum": 128, 
      "minimum": -128, 
      "title": "Number of special characters in password", 
      "type": "integer"
    }, 
    "upper_chars": {
      "default": -1, 
      "description": "Number of upper case characters (A..Z) expected in user password. <p>N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> upper case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 upper case character is required for a new password.", 
      "maximum": 128, 
      "minimum": -128, 
      "title": "Number of upper-case characters in password", 
      "type": "integer"
    }
  }, 
  "title": "Configuration of authentication and password policies for the NSX node", 
  "type": "object"
}

AuthenticationScheme (type)

{
  "additionalProperties": {}, 
  "id": "AuthenticationScheme", 
  "properties": {
    "scheme_name": {
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AutoRds (type)

{
  "description": "This object holds auto assigned route distinguishers for Layer 2 and Layer 3 configurations.", 
  "id": "AutoRds", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "l2_auto_rds": {
      "items": {
        "$ref": "L2AutoRD
      }, 
      "title": "List of layer 2 Auto assigned Route Distinguisher", 
      "type": "array"
    }, 
    "l3_auto_rd": {
      "description": "This field is auto assigned by the system. The auto RD seed is populated when user does not assign a route_distinguisher field in the gateway.", 
      "title": "Layer 3 Auto assigned Route Distinguisher", 
      "type": "string"
    }
  }, 
  "title": "Auto assigned Route Distinguishers", 
  "type": "object"
}

AutomaticHealthCheck (type)

{
  "description": "Health check performed by system automatically on a specific transport zone.  For overlay based zone, health check is performed on corresponding N-VDS of each transport node with the VLAN and MTU specified by uplink profile of N-VDS for the node.  For VLAN based zone, health check is performed on corresponding N-VDS of each  transport node with MTU specified by uplink profile of N-VDS for the node  and VLAN specified by all logical switches in this zone.", 
  "id": "AutomaticHealthCheck", 
  "module_id": "HealthCheck", 
  "properties": {
    "result": {
      "$ref": "HealthCheckResult, 
      "readonly": true
    }, 
    "transport_zone_id": {
      "description": "ID of the transport zone where this automatic health check is performed.", 
      "readonly": true, 
      "title": "Transport Zone ID", 
      "type": "string"
    }
  }, 
  "title": "Automatic Health Check", 
  "type": "object"
}

AutomaticHealthCheckListResult (type)

{
  "description": "Automatic health check list result for query with list parameters.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AutomaticHealthCheckListResult", 
  "module_id": "HealthCheck", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AutomaticHealthCheck
      }, 
      "readonly": true, 
      "title": "Automatic Health Check List", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Automatic Health Checks", 
  "type": "object"
}

AutomaticHealthCheckToggle (type)

{
  "description": "Toggle to enable/disable automatic health check.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AutomaticHealthCheckToggle", 
  "module_id": "HealthCheck", 
  "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"
    }, 
    "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"
    }, 
    "enabled": {
      "default": false, 
      "required": true, 
      "title": "Status of automatic health check", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Automatic Health Check Toggle", 
  "type": "object"
}

AviConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to a AVI type of enforcement point.", 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo
  }, 
  "id": "AviConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AviConnectionInfo"
  }, 
  "properties": {
    "cloud": {
      "deprecated": true, 
      "description": "Clouds are containers for the environment that Avi Vantage is installed or operating within. During initial setup of Vantage, a default cloud, named Default-Cloud, is created. This is where the first Controller is deployed, into Default-Cloud. Additional clouds may be added, containing SEs and virtual services. This is a deprecated property. Cloud has been renamed to cloud_name and it will added from specific ALB entity.", 
      "required": false, 
      "sensitive": false, 
      "title": "Cloud", 
      "type": "string"
    }, 
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "expires_at": {
      "description": "Expiry time of the token will be set by LCM at the time of Enforcement Point Creation.", 
      "required": false, 
      "title": "Expiry time of the token", 
      "type": "string"
    }, 
    "managed_by": {
      "description": "Managed by used when on-borading workflow created by LCM/VCF.", 
      "required": false, 
      "title": "Managed by used when on-borading workflow created by LCM/VCF.", 
      "type": "string"
    }, 
    "password": {
      "description": "Password or Token for Avi Controller.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password or Token for Avi Controller", 
      "type": "secure_string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo", 
        "AviConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }, 
    "status": {
      "$ref": "ALBEnforcementPointState, 
      "default": "DEACTIVATE_API", 
      "description": "This is connection property which checks whether ALB is connected to the controller. Enum options - ACTIVATE, DEACTIVATE_PROVIDER, DEACTIVATE_API. Default value is DEACTIVATE_API.", 
      "required": true, 
      "title": "Enforcement point state for ALB"
    }, 
    "tenant": {
      "description": "A tenant is an isolated instance of Avi Controller. Each Avi user account is associated with one or more tenants. The tenant associated with a user account defines the resources that user can access within Avi Vantage. When a user logs in, Avi restricts their access to only those resources that are in the same tenant", 
      "required": true, 
      "sensitive": false, 
      "title": "Tenant", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.", 
      "required": false, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "description": "Username.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "secure_string"
    }, 
    "version": {
      "deprecated": true, 
      "description": "Avi supports API versioning for backward compatibility with automation scripts written for an object model older than the current one. Such scripts need not be updated to keep up with object model changes This is a deprecated property. The version is now auto populated from property file and its value can be read using APIs", 
      "required": false, 
      "sensitive": false, 
      "title": "Version", 
      "type": "string"
    }
  }, 
  "title": "Avi Connection Info", 
  "type": "object"
}

AviEndPoint (type)

{
  "additionalProperties": false, 
  "description": "Details about the AVI LB endpoint", 
  "id": "AviEndPoint", 
  "module_id": "Migration", 
  "properties": {
    "avi_endpoint_ip": {
      "description": "IP address of the AVI LB endpoint.", 
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": true, 
      "title": "IP address of the AVI LB endpoint", 
      "type": "string"
    }, 
    "avi_endpoint_password": {
      "description": "Password for AVI LB endpoint.", 
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "Password for AVI LB endpoint", 
      "type": "secure_string"
    }, 
    "avi_endpoint_port": {
      "default": 443, 
      "description": "AVI LB endpoint port.", 
      "readonly": false, 
      "required": false, 
      "title": "AVI LB endpoint port", 
      "type": "int"
    }, 
    "avi_endpoint_username": {
      "description": "Username for AVI LB endpoint.", 
      "readonly": false, 
      "required": true, 
      "title": "Username for AVI LB endpoint", 
      "type": "string"
    }
  }, 
  "title": "AVI LB endpoint details", 
  "type": "object"
}

AwsAccount (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CloudAccount
  }, 
  "id": "AwsAccount", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "auth_method": {
      "description": "This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.", 
      "enum": [
        "CREDENTIALS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "AWS account authorization method", 
      "type": "string"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "credentials": {
      "$ref": "AwsCredentials, 
      "description": "Credentials of AWS Account.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Credentials"
    }, 
    "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"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual machines.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "last_inventory_sync_date": {
      "description": "Time when last inventory syncing completed.", 
      "readonly": true, 
      "required": false, 
      "title": "Last inventory sync date", 
      "type": "integer"
    }, 
    "regions_config": {
      "$ref": "RegionListConfig, 
      "description": "Configured list of regions to be used for the cloud account.", 
      "readonly": false, 
      "required": false, 
      "title": "List of regions configuration for the cloud account"
    }, 
    "regions_count": {
      "description": "Count of the AWS regions which have atleast one VPC created.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "AwsAccountStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Status of the account"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "AWS account", 
  "type": "object"
}

AwsAccountStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CloudAccountStatus
  }, 
  "id": "AwsAccountStatus", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Error encountered while syncing AWS inventory such as read timeout.", 
      "readonly": true, 
      "required": false, 
      "title": "Error encountered while syncing AWS inventory", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }, 
    "inventory_sync_step": {
      "description": "Step of the inventory synchronization process", 
      "enum": [
        "SYNCING_AWS_REGIONS", 
        "SYNCING_AWS_VPCS", 
        "SYNCING_AWS_AZS", 
        "SYNCING_VMS", 
        "SYNCING_NSX_DATA", 
        "SYNCING_AWS_GATEWAYS", 
        "SYNCING_MANAGED_INSTANCES", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "title": "Inventory sync step", 
      "type": "string"
    }
  }, 
  "title": "AWS account status", 
  "type": "object"
}

AwsAccountsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These parameters will be used to filter the list of accounts.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsAccountsListRequestParameters", 
  "module_id": "CloudAccounts", 
  "properties": {
    "cloud_type": {
      "decription": "Type of AWS cloud.\n", 
      "enum": [
        "AWS", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "required": false, 
      "title": "AWS Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which accounts statistics will be\naggregated. Using this request parameter will return\nonly all_accounts_vpc_stats and all_accounts_instance_stats properties.\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AWS account filter parameters", 
  "type": "object"
}

AwsAccountsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsAccountsListResult", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "all_accounts_instance_stats": {
      "$ref": "InstanceStats, 
      "deprecated": true, 
      "description": "This field is DEPRECATED. To obtain statistics about instances, use the GET /csm/accounts/statistics API.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "all_accounts_vpc_stats": {
      "$ref": "VpcStats, 
      "deprecated": true, 
      "description": "This field is DEPRECATED. To obtain statistics about VPCs, use the GET /csm/accounts/statistics API.", 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsAccount
      }, 
      "required": true, 
      "title": "AWS accounts list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud accounts list", 
  "type": "object"
}

AwsAvailabilityZoneInfo (type)

{
  "additionalProperties": false, 
  "id": "AwsAvailabilityZoneInfo", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Display name of the availability zone", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the availability zone", 
      "type": "string"
    }
  }, 
  "title": "Availability Zone information", 
  "type": "object"
}

AwsComputeVpcConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the parameters required for linking compute VPC with a transit VPC", 
  "extends": {
    "$ref": "AwsVpcConfig
  }, 
  "id": "AwsComputeVpcConfig", 
  "module_id": "AwsVpcInformation", 
  "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"
    }, 
    "account_id": {
      "deprecated": true, 
      "description": "AWS account ID related to the compute VPC. This field is deprecated. Field account_id can be learnt using vpc_id. GET /csm/aws/vpcs/<vpc-id> API returns associated_account_ids. Hence, this field is optional.", 
      "required": false, 
      "title": "AWS Account ID", 
      "type": "string"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.", 
      "title": "Id of Cloud Security Group", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AwsTransitVpcConfig, 
      "description": "All the required informations regarding a transit VPC will be absorbed as a part of this field.", 
      "required": true, 
      "title": "AWS Transit VPC Configuration"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "description": "Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.", 
      "title": "Flag to Identify if Default Quarantine Policy is Enabled", 
      "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"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this compute virtual private cloud is managed with or without NSX agents.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AWS Compute VPC Configuration", 
  "type": "object"
}

AwsComputeVpcListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of compute VPCs. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsComputeVpcListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "description": "Identifier for account based on which compute VPCs are to be filtered.", 
      "required": false, 
      "title": "AWS account ID", 
      "type": "string"
    }, 
    "associated_transit_vpc_id": {
      "description": "Identifier for filtering all the compute VPCs which are NSX managed by the given transit VPC.", 
      "required": false, 
      "title": "Transit VPC ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Identifier for VPC based on which the list can be filtered or can be used to validate that hierarchy is correct", 
      "required": false, 
      "title": "VPC ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsComputeVpcListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsComputeVpcListResult", 
  "module_id": "AwsVpcInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Compute VPCs", 
      "items": {
        "$ref": "AwsComputeVpcConfig
      }, 
      "required": false, 
      "title": "List of Compute VPC", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute Vpc list", 
  "type": "object"
}

AwsComputeVpcStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores onboard and offboard status of AWS VPC. There are 4 states in onboarding a VPC using transit VPC and the corresponding states in sequence are VALIDATING_ENVIRONMENT, CREATING_SECURITY_GROUPS, CONFIGURING_GATEWAY and ONBOARD_SUCCESSFUL. There are 3 states in offboarding a VPC and the corresponding states in sequence are UNCONFIGURING_GATEWAY, DELETING_SECURITY_GROUPS and OFFBOARD_SUCCESSFUL. The state of failure in onboarding or offboarding is indicated by ONBOARD_FAILED and OFFBOARD_FAILED.", 
  "extends": {
    "$ref": "VirtualPrivateCloudStatus
  }, 
  "id": "AwsComputeVpcStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "configuration": {
      "$ref": "AwsVpcConfig, 
      "description": "Stores AWS VPC configuration.", 
      "required": false, 
      "title": "AWS VPC Config"
    }, 
    "error_code": {
      "description": "Error code related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Code", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Error message related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "offboard_step": {
      "description": "Stores the different states of virtual private cloud while offboarding from a transit virtual private cloud.", 
      "enum": [
        "UNCONFIGURING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "OFFBOARD_SUCCESSFUL", 
        "OFFBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While OffBoard", 
      "type": "string"
    }, 
    "onboard_step": {
      "description": "Stores the different states of virtual private cloud while onboarding using a transit virtual private cloud.", 
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "CREATING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "ONBOARD_SUCCESSFUL", 
        "ONBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While Onboard", 
      "type": "string"
    }, 
    "status": {
      "description": "Indicates the status of a virtual private cloud. UP: virtual private cloud is NSX managed. DOWN: virtual private cloud is NSX managed with errors. ONBOARDING: virtual private cloud is in the process of   onboarding using a transit virtual private cloud. OFFBOARDING: virtual private cloud is in the process of    offboarding from a transit virtual private cloud. NOT_APPLICABLE: virtual private cloud is NSX unmanaged.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ONBOARDING", 
        "OFFBOARDING", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Private Cloud Status", 
      "type": "string"
    }, 
    "virtual_private_cloud_name": {
      "description": "Name of the transit virtual private cloud.", 
      "readonly": true, 
      "title": "Virtual Private Cloud Name", 
      "type": "string"
    }
  }, 
  "title": "VPC Status", 
  "type": "object"
}

AwsCredentials (type)

{
  "additional_properties": false, 
  "description": "Stores information about AWS account credentials.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsCredentials", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "access_key": {
      "description": "Access key of the AWS account.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Access Key", 
      "type": "secure_string"
    }, 
    "gateway_role": {
      "description": "Name of the IAM service role that should be attached to the Cloud Gateways deployed in the AWS account. Based on the permissions in the role, the gateways will have access to resources in the AWS account.", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway Role Name", 
      "type": "string"
    }, 
    "secret_key": {
      "description": "Secret key of the AWS account.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Secret Key", 
      "type": "secure_string"
    }
  }, 
  "title": "AWS Account Credentials", 
  "type": "object"
}

AwsGatewayAmiInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AwsGatewayAmiInfo", 
  "module_id": "AwsGatewayAmiInformation", 
  "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"
    }, 
    "ami_id": {
      "description": "The ID of the Amazon Machine Image", 
      "required": true, 
      "title": "AMI id", 
      "type": "string"
    }, 
    "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"
    }, 
    "region_id": {
      "required": true, 
      "title": "Name of the Aws Region in which ami is present", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Aws Gateway Ami Information", 
  "type": "object"
}

AwsGatewayAmisListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of AWS Gateway AMIs.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsGatewayAmisListRequestParameters", 
  "module_id": "AwsGatewayAmiInformation", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which list of AWS Gateway AMIs\nwill be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsGatewayAmisListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsGatewayAmisListResult", 
  "module_id": "AwsGatewayAmiInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsGatewayAmiInfo
      }, 
      "required": false, 
      "title": "Aws Gateway amis list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Aws Gateway amis", 
  "type": "object"
}

AwsGatewayConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway configuration like ami_id, key_pair_name and gateway_ha_configuration.", 
  "extends": {
    "$ref": "GatewayConfig
  }, 
  "id": "AwsGatewayConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "ami_id": {
      "description": "The ID of the Amazon Machine Image on which this gateway resides", 
      "required": false, 
      "title": "AMI id", 
      "type": "string"
    }, 
    "ami_id_obsolete": {
      "default": false, 
      "description": "If this flag is set, NSX was upgraded after the gateway was deployed and this AMI ID should no longer be used", 
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if the AMI ID is related to the previous NSX release", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed.", 
      "required": false, 
      "title": "Id of cloud security group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to identify if default quarantine policy is enabled", 
      "type": "boolean"
    }, 
    "dns_settings": {
      "$ref": "DnsSettings, 
      "deprecated": true, 
      "description": "Settings related to Cloud gateway DNS configuration. This determines DNS configuration based on dns_mode.", 
      "title": "DNS settings"
    }, 
    "gateway_connectivity_mode": {
      "description": "Helps the user choose default connectivity mode that will be used between Cloud Service Manager and Gateway. PUBLIC IP: All the connections will go through the internet. When this mode is selected by the user, the user will have to select a public Ip address from the list of public IP's from the 'Public IP on Mgmt NIC' field. PRIVATE IP: All the connections will go through the VGW or any other configured VPN. When there is no input provided by the user, an attempt will be made using PRIVATE_IP (VGW) first and if that doesn't go through, an attempt will be made using PUBLIC_IP (IGW). And if both fail, it will cause an exception.", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "title": "Gateway Connectivity Mode", 
      "type": "string"
    }, 
    "gateway_ha_configuration": {
      "items": {
        "$ref": "AwsGatewayHaConfig
      }, 
      "required": false, 
      "title": "Aws Gateway HA configuration", 
      "type": "array"
    }, 
    "is_ha_enabled": {
      "required": false, 
      "title": "Flag to identify if HA is enabled", 
      "type": "boolean"
    }, 
    "key_pair_name": {
      "required": false, 
      "title": "The key pair name required to authenticate into any instance", 
      "type": "string"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this virtual private cloud is managed with or without NSX agents. This flag is applicable only for this network. If this virtual private cloud is being managed without NSX agents, quarantine state and threat state will be NOT_APPLICABLE for all the virtual machines under it.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "nsx_manager_connection": {
      "description": "Determines if connection to NSX Manager is via public IP or private IP", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "required": false, 
      "title": "NSX Manager connection", 
      "type": "string"
    }, 
    "proxy_server_profile": {
      "description": "Id of the proxy server profile, corresponding proxy settings will be applied while deploying the gateway.", 
      "required": false, 
      "title": "Id of the proxy server profile", 
      "type": "string"
    }, 
    "target_disk_size": {
      "description": "This is the target disk size of the PCG appliance in GB. Based on this an additional disk is attached to the PCG appliance, if required. The supported size is 191 GB and this property should only be modified post upgrade for exisiting PCG appliances.", 
      "required": false, 
      "title": "Target Disk Size", 
      "type": "integer"
    }, 
    "vpn_service_enabled": {
      "default": true, 
      "description": "Flag that will enable or disable inter-operation between NSX and non-NSX services via VPN.", 
      "required": false, 
      "title": "Flag to enable or disable inter-operation with services via VPN", 
      "type": "boolean"
    }
  }, 
  "title": "AWS gateway configuration", 
  "type": "object"
}

AwsGatewayDeployConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsGatewayDeployConfig", 
  "module_id": "AwsGatewayManagement", 
  "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"
    }, 
    "account_id": {
      "required": true, 
      "title": "ID of the AWS account", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AwsGatewayConfig, 
      "readonly": true, 
      "required": false, 
      "title": "Configuration of this gateway"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "ID of the vpc", 
      "type": "string"
    }
  }, 
  "title": "AWS gateway deployment configuration", 
  "type": "object"
}

AwsGatewayHaConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsGatewayHaConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "availability_zone": {
      "required": true, 
      "title": "Availability Zone", 
      "type": "string"
    }, 
    "downlink_subnet": {
      "required": true, 
      "title": "Downlink subnet", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": true, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "management_subnet": {
      "required": true, 
      "title": "Management subnet", 
      "type": "string"
    }, 
    "private_ip_settings": {
      "$ref": "GatewayPrivateIp, 
      "description": "Stores settings related to AWS gateway Private IP configuration. The private_ip will be attached to management interface of the gateway, based on the value of ip_allocation_mode.", 
      "required": false, 
      "title": "Private IP settings for management interface"
    }, 
    "public_ip_settings": {
      "$ref": "GatewayPublicIp, 
      "description": "Stores settings related to AWS gateway Public IP configuration. The public_ip will be attached to management interface of the gateway, based on the value of ip_allocation_mode.", 
      "required": false, 
      "title": "Public IP settings for management interface"
    }, 
    "uplink_public_ip_settings": {
      "$ref": "GatewayPublicIp, 
      "description": "Stores settings related to AWS gateway Public IP configuration. The public_ip will be attached to uplink interface of the primary gateway, based on the value of ip_allocation_mode.", 
      "required": false, 
      "title": "Public IP settings for uplink interface"
    }, 
    "uplink_subnet": {
      "required": true, 
      "title": "Uplink subnet", 
      "type": "string"
    }
  }, 
  "title": "AWS subnet configuration to deploy gateways", 
  "type": "object"
}

AwsGatewayInfo (type)

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway information like configuration and status.", 
  "id": "AwsGatewayInfo", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "configuration": {
      "$ref": "AwsGatewayConfig, 
      "description": "Configuration of AWS gateway", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Configuration"
    }, 
    "csm_ip_address": {
      "description": "Cloud service manager IP address used to communicate with the AWS Vpc gateways.", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud service manager IP address", 
      "type": "string"
    }, 
    "gateway_status": {
      "$ref": "AwsGatewayStatus, 
      "description": "Array of gateway statuses", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status"
    }
  }, 
  "title": "AWS Gateway Information", 
  "type": "object"
}

AwsGatewayInstanceStatus (type)

{
  "description": "Stores information about AWS gateway instance status", 
  "extends": {
    "$ref": "GatewayInstanceStatus
  }, 
  "id": "AwsGatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "configuration_operation_status": {
      "$ref": "GatewayConfigOperationStatus, 
      "description": "This property provides a consolidated status of supported gateway configuration operations.", 
      "readonly": true, 
      "required": false, 
      "title": "Status of different gateway configuration operations"
    }, 
    "deployment_step": {
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "COPYING_IMAGE", 
        "CREATING_SECURITY_GROUPS", 
        "LAUNCHING_GATEWAY", 
        "CREATING_NETWORK_INTERFACES", 
        "ATTACHING_NETWORK_INTERFACES", 
        "ATTACHING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "CREATING_LOGICAL_NETWORK_CONSTRUCTS", 
        "DEPLOYMENT_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNCONFIGURING_GATEWAY", 
        "RELEASING_EIPS", 
        "TERMINATING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "DELETING_CLOUD_RESOURCES", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_FAILED", 
        "NOT_APPLICABLE", 
        "CLEANUP_INPROGRESS", 
        "CLEANUP_FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway operation failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway operation failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "AWS gateway instance status", 
  "type": "object"
}

AwsGatewayStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway status related information", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsGatewayStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "gateway_cluster_id": {
      "description": "Cluster ID of NSX gateway", 
      "required": false, 
      "title": "NSX gateway cluster ID", 
      "type": "string"
    }, 
    "gateway_instances_status": {
      "description": "Array of gateway instances statuses", 
      "items": {
        "$ref": "AwsGatewayInstanceStatus
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Instances Status", 
      "type": "array"
    }
  }, 
  "title": "AWS Gateway Status", 
  "type": "object"
}

AwsGatewayUndeployConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsGatewayUndeployConfig", 
  "module_id": "AwsGatewayManagement", 
  "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"
    }, 
    "account_id": {
      "required": true, 
      "title": "ID of the AWS account", 
      "type": "string"
    }, 
    "instance_id": {
      "required": true, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }
  }, 
  "title": "AWS gateway undeployment configuration", 
  "type": "object"
}

AwsGatewaysListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of AWS Gateways. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsGatewaysListRequestParameters", 
  "module_id": "AwsGatewayManagement", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which AWS gateways list can be filtered.", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which AWS gateways list can be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for vpc based on which AWS gateways list can be filtered.", 
      "required": false, 
      "title": "VPC ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsGatewaysListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsGatewaysListResult", 
  "module_id": "AwsGatewayManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsGatewayDeployConfig
      }, 
      "required": false, 
      "title": "Vpc list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AWS Gateways List Result", 
  "type": "object"
}

AwsKeyPair (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AwsKeyPair", 
  "module_id": "AwsResources", 
  "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"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the Aws Key Pair", 
      "type": "string"
    }
  }, 
  "title": "Aws Key Pair", 
  "type": "object"
}

AwsKeyPairList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsKeyPairList", 
  "module_id": "AwsResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsKeyPair
      }, 
      "required": false, 
      "title": "Aws Key Pairs list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Aws Key Pairs", 
  "type": "object"
}

AwsKeyPairListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of subnets. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsKeyPairListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which list of key pairs will be obtained\n", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": true, 
      "title": "Identifier for region based on which list of key pairs will be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsPublicIpListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Aws public IPs.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsPublicIpListResult", 
  "module_id": "AwsResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Aws public IPs.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "AWS public IP", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws Public IP List Result", 
  "type": "object"
}

AwsRegion (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AwsRegion", 
  "module_id": "AwsRegionInformation", 
  "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"
    }, 
    "associated_account_ids": {
      "description": "Array of associated AWS account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated AWS Account IDs", 
      "type": "array"
    }, 
    "availability_zones": {
      "items": {
        "$ref": "AwsAvailabilityZoneInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Availability zones under this region", 
      "type": "array"
    }, 
    "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"
    }, 
    "gateway_stats": {
      "$ref": "GatewayStats, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway statistics"
    }, 
    "has_managed_vpc": {
      "readonly": true, 
      "required": false, 
      "title": "Has a managed VPC?", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "Aws Region Information", 
  "type": "object"
}

AwsRegionsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of regions. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsRegionsListRequestParameters", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which regions are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which the list can be filtered or can be used\nto validate that hierarchy is correct\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsRegionsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsRegionsListResult", 
  "module_id": "AwsRegionInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsRegion
      }, 
      "required": false, 
      "title": "Aws Regions list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AwsRegions list", 
  "type": "object"
}

AwsResourcesListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Aws resources. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsResourcesListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which resources are to be filtered.", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources are to be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for \"nsx.vpc\" tag on which public IPs are to be filtered.", 
      "required": false, 
      "title": "AWS Virtual Private Center ID", 
      "type": "string"
    }
  }, 
  "title": "Aws Resource List Request Parameters", 
  "type": "object"
}

AwsSecurityGroup (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an AWS security group.", 
  "extends": {
    "$ref": "CloudSecurityGroup
  }, 
  "id": "AwsSecurityGroup", 
  "module_id": "AwsVpcResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cloud_tags": {
      "description": "Array of tags associated to a cloud security group.", 
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "title": "Cloud Tags", 
      "type": "array"
    }, 
    "description": {
      "description": "Description of AWS security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group Description", 
      "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"
    }, 
    "inbound_rules": {
      "description": "Array of inbound rules of the AWS security group.", 
      "items": {
        "$ref": "AwsSecurityGroupRule
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Inbound Rules", 
      "type": "array"
    }, 
    "instances_count": {
      "description": "Number of instances associated to cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Count Of Instances", 
      "type": "integer"
    }, 
    "is_managed_by_nsx": {
      "description": "If the flag is true, the cloud security group is managed by NSX.", 
      "readonly": true, 
      "required": false, 
      "title": "Is Managed By NSX", 
      "type": "boolean"
    }, 
    "nsx_security_group": {
      "$ref": "SecurityGroup, 
      "description": "Stores information about the NSX security group corresponding to the AWS security group.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Group"
    }, 
    "outbound_rules": {
      "description": "Array of outbound rules of the AWS security group.", 
      "items": {
        "$ref": "AwsSecurityGroupRule
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Outbound Rules", 
      "type": "array"
    }, 
    "region_id": {
      "description": "ID of the cloud region.", 
      "readonly": true, 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AWS Security Group", 
  "type": "object"
}

AwsSecurityGroupRule (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an AWS security group rule.", 
  "extends": {
    "$ref": "CloudSecurityGroupRule
  }, 
  "id": "AwsSecurityGroupRule", 
  "module_id": "AwsVpcResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination": {
      "description": "Destination corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Destination", 
      "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"
    }, 
    "port_range": {
      "description": "Port range corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Port Range", 
      "type": "string"
    }, 
    "protocol": {
      "description": "Protocol corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Protocol", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "source": {
      "description": "Source corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Source", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "description": "Type of AWS security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "AWS Security Group Rule", 
  "type": "object"
}

AwsSecurityGroupsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Aws security groups. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "AwsResourcesListRequestParameters
  }, 
  "id": "AwsSecurityGroupsListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which resources are to be filtered.", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources are to be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for region based on which resources are to be filtered.", 
      "required": true, 
      "title": "Region ID", 
      "type": "string"
    }
  }, 
  "title": "Aws Security Groups List Request Parameters", 
  "type": "object"
}

AwsSecurityGroupsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of AWS security groups.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsSecurityGroupsListResult", 
  "module_id": "AwsVpcResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of AWS security groups.", 
      "items": {
        "$ref": "AwsSecurityGroup
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AWS Security Groups List Result", 
  "type": "object"
}

AwsServiceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Stores information about any service endpoint which is provided by AWS. NSX supported services are currently limited to Simple Storage Service (S3), Relational Database Service (RDS), DynamoDB and Elastic Load Balancing.", 
  "extends": {
    "$ref": "CloudServiceEndpoint
  }, 
  "id": "AwsServiceEndpoint", 
  "module_id": "AwsVpcResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cidrs": {
      "description": "Array of CIDRs associated to an AWS service.", 
      "items": {
        "format": "ipv4-cidr-block", 
        "type": "string"
      }, 
      "readonly": true, 
      "title": "CIDRs", 
      "type": "array"
    }, 
    "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"
    }, 
    "nsx_security_groups": {
      "description": "Stores an array of NSX security groups associated to this cloud service endpoint.", 
      "items": {
        "$ref": "SecurityGroup
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX security groups array", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_endpoint_id": {
      "description": "Cloud provided ID of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint ID", 
      "type": "string"
    }, 
    "service_endpoint_type": {
      "description": "Cloud provided type of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint Type", 
      "type": "string"
    }, 
    "service_name": {
      "description": "Name of the cloud service the endpoint is associated with.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Name", 
      "type": "string"
    }, 
    "service_type": {
      "description": "Stores the type of AWS service corresponding to this endpoint. AWS_RDS - Amazon Relational Database Service AWS_DYNAMODB - Amazon DynamoDB AWS_S3 - Amazon Simple Storage Service AWS_ELB - Amazon Elastic Load Balancer", 
      "enum": [
        "AWS_RDS", 
        "AWS_DYNAMODB", 
        "AWS_S3", 
        "AWS_ELB"
      ], 
      "readonly": true, 
      "title": "Service type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AWS Service Endpoint", 
  "type": "object"
}

AwsServiceEndpointsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of service endpoints which are provided by AWS with information about each of them. NSX supported services are currently limited to Simple Storage Service (S3), Relational Database Service (RDS), DynamoDB and Elastic Load Balancing.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsServiceEndpointsListResult", 
  "module_id": "AwsVpcResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of AWS service endpoints.", 
      "items": {
        "$ref": "AwsServiceEndpoint
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AWS Service Endpoints List Result", 
  "type": "object"
}

AwsSubnet (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "AwsSubnet", 
  "module_id": "AwsResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "availability_zone": {
      "required": false, 
      "tilte": "Availability zone", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4-cidr-block", 
      "required": true, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "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": {
      "required": true, 
      "title": "ID of subnet", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "ID of the vpc", 
      "type": "string"
    }
  }, 
  "title": "Aws subnet", 
  "type": "object"
}

AwsSubnetListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of subnets. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsSubnetListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "availability_zone_name": {
      "required": true, 
      "title": "Identifier for availability zone based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_name": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. region_name will be learnt from vpc_id information.", 
      "required": false, 
      "title": "Identifier for region based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "Identifier for vpc based on which subnets are to be filtered", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsSubnetListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsSubnetListResult", 
  "module_id": "AwsResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsSubnet
      }, 
      "required": true, 
      "title": "Aws subnets list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws subnets list", 
  "type": "object"
}

AwsTransitVpcConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the account IDs and VPC ID related to the transit VPC.", 
  "id": "AwsTransitVpcConfig", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "deprecated": true, 
      "description": "AWS account ID of the transit VPC. This field is deprecated. Field account_id can be learnt using vpc_id. GET /csm/aws/vpcs/<vpc-id> API returns associated_account_ids. Hence, this field is optional.", 
      "required": false, 
      "title": "AWS account ID", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "VPC ID of the transit VPC.", 
      "required": true, 
      "title": "VPC ID", 
      "type": "string"
    }
  }, 
  "title": "AWS Transit VPC Configuration", 
  "type": "object"
}

AwsTransitVpcInfo (type)

{
  "description": "Stores the account ID and VPC ID related to the transit VPC. A transit VPC is a AWS VPC in which public cloud gateways are deployed and is managing the workload VMs present in other compute VPCs.", 
  "extends": {
    "$ref": "VirtualPrivateCloudInfo
  }, 
  "id": "AwsTransitVpcInfo", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "associated_account_ids": {
      "description": "Cloud account ID related to the virtual private cloud.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Array of Cloud Account IDs", 
      "type": "array"
    }, 
    "virtual_private_cloud_id": {
      "description": "Virtual private cloud ID of the corresponding cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Private Cloud ID", 
      "type": "string"
    }, 
    "virtual_private_cloud_name": {
      "description": "Virtual private cloud name of the corresponding cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Private Cloud name", 
      "type": "string"
    }
  }, 
  "title": "AWS Transit VPC Information", 
  "type": "object"
}

AwsVirtualMachine (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a AWS Virtual Machine", 
  "extends": {
    "$ref": "CloudVirtualMachine
  }, 
  "id": "AwsVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AwsVirtualMachine"
  }, 
  "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"
    }, 
    "agent_status": {
      "description": "UP - NSX Agent is up and running DOWN - NSX Agent is down NO_AGENT - No NSX Agent installed on instance UNKNOWN - NSX Agent status is unknown NEEDS_UPDATE - NSX Agent running on instance needs to be updated", 
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT", 
        "UNKNOWN", 
        "NEEDS_UPDATE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "availability_zone": {
      "description": "AWS availability zone in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Availability Zone", 
      "type": "string"
    }, 
    "cloud_instance_type": {
      "description": "This field represents various type of service instances in cloud. VIRTUAL_MACHINE: Virtual machine deployed in public cloud. AWS_RDS_INSTANCE: Amazon Relational Database Service Instance. AWS_RDS_CLUSTER: Amazon Relational Database Service Cluster. AWS_APPLICATION_ELB_INSTANCE: Amazon Application Elastic LoadBalancer. AWS_CLASSIC_ELB_INSTANCE: Amazon Classic Elastic LoadBalancer. HORIZON_MANAGEMENT: Virtual Machines that are deployed on Microsoft Azure using Horizon Cloud Services(HCS) that are used for managing other instances in the network. This includes, Management VMs, Unified Access Gateway (UAG) VMs, Base VMs. HORIZON_VDI: Virtual Desktop Image (VDI) deployed on Microsoft Azure using Horizon Cloud Services(HCS).", 
      "enum": [
        "VIRTUAL_MACHINE", 
        "AWS_RDS_INSTANCE", 
        "AWS_RDS_CLUSTER", 
        "AWS_APPLICATION_ELB_INSTANCE", 
        "AWS_CLASSIC_ELB_INSTANCE", 
        "HORIZON_MANAGEMENT", 
        "HORIZON_VDI"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Instance Type", 
      "type": "string"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the instance", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages identified in the last 1 hour.", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway.", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if instance is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_failed_rules_count": {
      "description": "Number of NSX firewall rules failed to realize on cloud for the instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX failed rules count", 
      "type": "integer"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "nsx_security_group_mapping": {
      "description": "Map of cloud security groups associated to the instance and corresponding NSX security groups.", 
      "items": {
        "$ref": "SecurityGroupDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Group Mapping", 
      "type": "array"
    }, 
    "nsx_security_rule_errors": {
      "deprecated": true, 
      "description": "DEPRECATED. Array of NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "items": {
        "$ref": "NsxSecurityRuleErrorDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors", 
      "type": "array"
    }, 
    "nsx_security_rule_errors_count": {
      "deprecated": true, 
      "description": "DEPRECATED. Count of the NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors Count", 
      "type": "integer"
    }, 
    "nsx_successful_rules_count": {
      "description": "Number of NSX firewall rules successfully configured for this instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX successful rules count", 
      "type": "integer"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the instance", 
      "type": "string"
    }, 
    "power_state": {
      "description": "Indicates the power state of the virtual machine as returned by AWS.", 
      "enum": [
        "PENDING", 
        "RUNNING", 
        "SHUTTING_DOWN", 
        "TERMINATED", 
        "STOPPING", 
        "STOPPED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Power State", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the instance", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the instance", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the instance. QUARANTINED - This state implies instance is moved to quarantine security group because some threat has been detected. NOT_QUARANTINED - This state implies no quarantine action has been taken. UNKNOWN - This state implies either quarantine policy is disabled or quarantine information is not available. OVERRIDDEN - This state implies instance is associated with vm_override_sg which overrides any action based on threat detection. WHITELISTED - This state implies that quarantine operation will not be performed on the instance [DEPRECATED - replaced with USERMANAGED]. USERMANAGED - This state implies that quarantine operation will not be performed on the instance. NOT_APPLICABLE - This state will be populated for agentless instance, Horizon Management instance.", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN", 
        "WHITELISTED", 
        "USERMANAGED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region": {
      "description": "AWS region in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Region", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of VirtualMachine prefixed by cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "segment_display_name": {
      "description": "Segment display name on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment display name", 
      "type": "string"
    }, 
    "segment_id": {
      "description": "Segment ID on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment ID", 
      "type": "string"
    }, 
    "status": {
      "description": "POWERED_ON - Powered on instance POWERED_OFF - Powered off instance MANAGED_GATEWAY - Instances that are public cloud gateways MANAGED - Instances that are managed by NSX UNMANAGED - Instances that are not managed by NSX or untagged ERRORED - Instances with no NSX Agent connectivity, NSX Agent is down, No NSX Policy configured for Agentless VMs or Error on NSX Policy rule realization. QUARANTINED - Instances which have been quarantined WHITELISTED - Instances which have been whitelisted [DEPRECATED - replaced with USERMANAGED] USERMANAGED - Instances which have been marked as usermanaged.", 
      "enum": [
        "POWERED_ON", 
        "POWERED_OFF", 
        "UNMANAGED", 
        "MANAGED_GATEWAY", 
        "MANAGED", 
        "ERRORED", 
        "QUARANTINED", 
        "WHITELISTED", 
        "USERMANAGED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Instance status", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the instance. NORMAL - This state implies no threat has been detected and instance is functioning as expected. THREAT - This state implies quarantine enabling threat has been detected. INVALID - This state implies either instance is unmanaged or threat related information is not available. NOT_APPLICABLE - This state will be populated for agentless instance.", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_config_status": {
      "$ref": "VmConfigStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Status for user configurable properties"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available           regarding extension execution. This can potentially occur for           a VM when agent is installed out of band or if           cloud_agent_automated_install_enabled flag is enabled for the           VNET/VPC which already has managed VMs. SUCCESSFUL - Indicates VM extension script execution was successful.           This does not necessarily mean agent installation was           successful. FAILED - Indicates VM extension script execution failed.", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }, 
    "vpc": {
      "description": "AWS VPC ID in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS VPC", 
      "type": "string"
    }, 
    "vpc_name": {
      "description": "AWS VPC name in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS VPC name", 
      "type": "string"
    }
  }, 
  "title": "Aws Virtual Machine Information", 
  "type": "object"
}

AwsVpc (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AwsVpc", 
  "module_id": "AwsVpcInformation", 
  "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"
    }, 
    "agent_info": {
      "description": "Array of agent install and download instructions for various OS types.", 
      "items": {
        "$ref": "AgentInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Aws Agent Information", 
      "type": "array"
    }, 
    "ami_id": {
      "description": "Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine with the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using Amazon EC2", 
      "readonly": true, 
      "required": false, 
      "title": "AMI ID", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated AWS account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated AWS Account IDs", 
      "type": "array"
    }, 
    "associated_transit_vpc": {
      "$ref": "AwsTransitVpcInfo, 
      "description": "Stores the VPC ID and associated account IDs of the transit VPC. This property describes the associated transit VPC for a given AWS compute VPC.", 
      "readonly": true, 
      "required": false, 
      "title": "Associated AWS Transit VPC"
    }, 
    "cidr": {
      "deprecated": true, 
      "description": "This field is DEPRECATED as AWS started supporting multiple CIDR blocks per VPC. This field will return only the first CIDR block from the response received from AWS. Please use cidr_blocks to see the multiple CIDR blocks associated with the VPC.", 
      "format": "ipv4-cidr-block", 
      "readonly": true, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "cidr_blocks": {
      "description": "IPv4 CIDR Block of the virtual network.", 
      "items": {
        "$ref": "CidrBlock
      }, 
      "readonly": true, 
      "title": "IPv4 CIDR Block", 
      "type": "array"
    }, 
    "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"
    }, 
    "gateway_info": {
      "$ref": "AwsGatewayInfo, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway details for the Vpc"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "readonly": true, 
      "required": false, 
      "title": "Managed, unmanaged and error instance counts for the Vpc"
    }, 
    "is_management_vpc": {
      "default": false, 
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is the management Vpc", 
      "type": "boolean"
    }, 
    "managed_vpcs": {
      "description": "Array of compute VPCs managed by a transit VPC. This property describes array of managed compute VPC for a given transit VPC.", 
      "items": {
        "$ref": "ManagedVpcInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of NSX Managed Compute VPCs", 
      "type": "array"
    }, 
    "op_status": {
      "$ref": "AwsVpcOpStatus, 
      "description": "Operational status of the VPC.", 
      "readonly": true, 
      "title": "AWS VPC Operational Status"
    }, 
    "region_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the AWS region", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zones": {
      "items": {
        "$ref": "TransportZoneInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Transport zones for the Vpc", 
      "type": "array"
    }, 
    "vpc_status": {
      "$ref": "AwsComputeVpcStatus, 
      "description": "Stores onboard and offboard states and corresponding error messages and error code related to AWS compute VPC. The status for a transit VPC should be obtained from gateway_info.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Compute VPC Status"
    }
  }, 
  "title": "Vpc Information", 
  "type": "object"
}

AwsVpcConfig (type)

{
  "description": "Stores the configuration such as default_quarantine_policy_enabled and cloud_fallback_security_group_id for related AWS VPC.", 
  "extends": {
    "$ref": "VirtualPrivateCloudConfig
  }, 
  "id": "AwsVpcConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.", 
      "title": "Id of Cloud Security Group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "description": "Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.", 
      "title": "Flag to Identify if Default Quarantine Policy is Enabled", 
      "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"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this compute virtual private cloud is managed with or without NSX agents.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AWS VPC Configuration", 
  "type": "object"
}

AwsVpcListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of Vpcs. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsVpcListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "associated_transit_vpc_id": {
      "description": "Identifier for filtering all the compute VPCs which are NSX managed by the given transit VPC.", 
      "required": false, 
      "title": "Transit VPC ID", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4-cidr-block", 
      "required": false, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "op_status": {
      "$ref": "AwsVpcOpStatus, 
      "description": "Operational status of the VPC.", 
      "title": "AWS VPC Operational Status"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status_filter": {
      "description": "MANAGED - VPC is managed by NSX UNMANAGED - VPC is not managed by NSX ERRORED - VPC is in error state", 
      "enum": [
        "MANAGED", 
        "UNMANAGED", 
        "ERRORED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Filter by overall VPC status", 
      "type": "string"
    }, 
    "vpc_id": {
      "required": false, 
      "title": "Identifier for vpc based on which the list can be filtered or can be\nused to validate that hierarchy is correct\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsVpcListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AwsVpcListResult", 
  "module_id": "AwsVpcInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsVpc
      }, 
      "required": false, 
      "title": "Vpc list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Vpc list", 
  "type": "object"
}

AwsVpcOpStatus (type)

{
  "description": "Operational status of the AWS VPC. After there are gateways deployed in a VPC, that VPC is called as transit VPC and it's status will be set as NSX_MANAGED_BY_GATEWAY. For all the compute VNets which are being managed by a transit VPC, their status will be set as NSX_MANAGED_BY_TRANSIT_VPC. NSX_GATEWAY_ERROR status means gateways are deployed in VPC, but no gateway is UP and at least one gateway is DOWN. The remaining gateway can be in NOT_AVAILABLE state. NSX_COMPUTE_ERROR status will be shown in compute VPC when transit VPC is in NSX_GATEWAY_ERROR state. Status for all the rest of the VPCs will be NSX_UNMANAGED. NSX_MANAGED is deprecated.", 
  "enum": [
    "NSX_MANAGED_BY_GATEWAY", 
    "NSX_MANAGED_BY_TRANSIT_VPC", 
    "NSX_MANAGED", 
    "NSX_UNMANAGED", 
    "NSX_GATEWAY_ERROR", 
    "NSX_COMPUTE_ERROR"
  ], 
  "id": "AwsVpcOpStatus", 
  "module_id": "CloudServiceManager", 
  "readonly": true, 
  "required": false, 
  "title": "Operational Status", 
  "type": "string"
}

Axes (type)

{
  "additionalProperties": false, 
  "description": "Represents X and Y axes of a graph. For a multi-graph, the same axes are shared by all the graphs.", 
  "id": "Axes", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "x_label": {
      "$ref": "Label, 
      "decription": "Describes the X axis of a graph. If x_label is not specified, the label will not appear for X axis. To have a support for mulitple condition use 'x-labels' property.", 
      "title": "Label for X axis of a graph"
    }, 
    "x_labels": {
      "description": "A list of X-Axis Labels with condition support. If needed, this property can be used to provide a list of x-axis label with condition support. For a label with single condition,'x-label' property can be used.", 
      "items": {
        "$ref": "Label
      }, 
      "minItems": 0, 
      "title": "A list of X-Axis Labels with condition support.", 
      "type": "array"
    }, 
    "y_axis_unit_labels": {
      "description": "A list of Y-Axis unit Labels with condition support. If needed, this property can be used to provide a list of y-axis unit label with condition support. This unit label can be used to display the point value along with units like percentage, milliseconds etc.", 
      "items": {
        "$ref": "Label
      }, 
      "minItems": 0, 
      "title": "A list of Y-Axis unit Labels with condition support.", 
      "type": "array"
    }, 
    "y_axis_units": {
      "description": "A list of Y-Axis unit with condition support. If needed, this property can be used to provide a list of y-axis unit with condition support. This unit could be like percentage, seconds, milliseconds etc.", 
      "items": {
        "$ref": "AxisUnit
      }, 
      "minItems": 0, 
      "title": "A list of Y-Axis unit with condition support.", 
      "type": "array"
    }, 
    "y_label": {
      "$ref": "Label, 
      "decription": "Describes the Y axis of a graph. If y_label is not specified, the label will not appear for Y axis.", 
      "title": "Label for Y axis of a graph"
    }, 
    "y_labels": {
      "description": "A list of Y-Axis Labels with condition support. If needed, this property can be used to provide a list of y-axis label with condition support. For a label with single condition,'y-label' property can be used.", 
      "items": {
        "$ref": "Label
      }, 
      "minItems": 0, 
      "title": "A list of Y-Axis Labels with condition support.", 
      "type": "array"
    }
  }, 
  "title": "Axes of a graph", 
  "type": "object"
}

AxisUnit (type)

{
  "additionalProperties": false, 
  "description": "Represents X and Y axis unit of a graph.", 
  "id": "AxisUnit", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the above unit will be displayed. to UI. If no condition is provided, then the unit will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "unit": {
      "description": "An Axis unit.", 
      "enum": [
        "COUNT", 
        "PERCENT", 
        "BYTES", 
        "MILLISECONDS", 
        "SECONDS", 
        "MINUTE", 
        "HOUR", 
        "DAY", 
        "KILO_BYTES", 
        "MEGA_BYTES", 
        "GIGA_BYTES"
      ], 
      "title": "An Axis unit.", 
      "type": "string"
    }
  }, 
  "title": "Axis unit of a graph", 
  "type": "object"
}

AzureAccount (type)

{
  "additional_properties": false, 
  "description": "Stores information about an Azure account", 
  "extends": {
    "$ref": "CloudAccount
  }, 
  "id": "AzureAccount", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "auth_method": {
      "description": "This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.", 
      "enum": [
        "CREDENTIALS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Azure account authorization method", 
      "type": "string"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "credentials": {
      "$ref": "AzureCredentials, 
      "description": "Credentials of Azure Account.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Credentials"
    }, 
    "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"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual machines.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "last_inventory_sync_date": {
      "description": "Time when last inventory syncing completed.", 
      "readonly": true, 
      "required": false, 
      "title": "Last inventory sync date", 
      "type": "integer"
    }, 
    "regions_config": {
      "$ref": "RegionListConfig, 
      "description": "Configured list of regions to be used for the cloud account.", 
      "readonly": false, 
      "required": false, 
      "title": "List of regions configuration for the cloud account"
    }, 
    "regions_count": {
      "description": "Count of the Azure regions which have atleast one virtual network created.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "AzureAccountStatus, 
      "description": "Status of the Azure Account.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Account Status"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }, 
    "vnet_stats": {
      "$ref": "VnetStats, 
      "description": "Stores statistics of the number of MANAGED and UNMANAGED virtual networks.", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Network Statistics"
    }
  }, 
  "title": "Azure Account", 
  "type": "object"
}

AzureAccountStatus (type)

{
  "additional_properties": false, 
  "description": "Stores information about Azure account status.", 
  "extends": {
    "$ref": "CloudAccountStatus
  }, 
  "id": "AzureAccountStatus", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Error encountered while syncing azure inventory such as read timeout.", 
      "readonly": true, 
      "required": false, 
      "title": "Error encountered while syncing azure inventory", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }, 
    "inventory_sync_step": {
      "description": "Step of the inventory synchronization process.", 
      "enum": [
        "SYNCING_AZURE_REGIONS", 
        "SYNCING_AZURE_VNETS", 
        "SYNCING_VMS", 
        "SYNCING_NSX_DATA", 
        "SYNCING_AZURE_GATEWAYS", 
        "SYNCING_MANAGED_INSTANCES", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory sync step", 
      "type": "string"
    }
  }, 
  "title": "Azure Account Status", 
  "type": "object"
}

AzureAccountsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These parameters will be used to filter the list of accounts.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureAccountsListRequestParameters", 
  "module_id": "CloudAccounts", 
  "properties": {
    "cloud_type": {
      "description": "Type of Azure cloud.", 
      "enum": [
        "AZURE", 
        "AZURE_GOV_US"
      ], 
      "required": false, 
      "title": "Azure Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure account filter parameters", 
  "type": "object"
}

AzureAccountsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure accounts.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureAccountsListResult", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure accounts.", 
      "items": {
        "$ref": "AzureAccount
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Accounts List Result", 
  "type": "object"
}

AzureComputeVNetConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the parameters required for linking compute VNet with the Transit VNet.", 
  "extends": {
    "$ref": "AzureVNetConfig
  }, 
  "id": "AzureComputeVNetConfig", 
  "module_id": "AzureVnetInformation", 
  "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"
    }, 
    "account_id": {
      "deprecated": true, 
      "description": "Azure account ID related to the compute VNet. This field is deprecated. Field account_id can be learnt using vnet_id. GET /csm/azure/vnets/<vnet-id> API returns associated_account_ids. Hence, this field is optional.", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "auto_agent_install_enabled": {
      "default": false, 
      "description": "Flag to identify if NSX agent installation will be done automatically or not. As of now this is supported for Azure Cloud only. If the flag managed_without_agents is set to true, this property will be ignored.", 
      "required": false, 
      "title": "Auto Agent Install Enabled", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.", 
      "title": "Id of Cloud Security Group", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AzureTransitVnetConfig, 
      "description": "All the required informations regarding a transit VNet will be absorbed as a part of this field.", 
      "required": true, 
      "title": "Azure Transit VNet Configuration"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "description": "Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.", 
      "title": "Flag to Identify if Default Quarantine Policy is Enabled", 
      "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"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this compute virtual private cloud is managed with or without NSX agents.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Azure Compute VNet Configuration", 
  "type": "object"
}

AzureComputeVNetListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of compute VNets. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureComputeVNetListRequestParameters", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "account_id": {
      "description": "Identifier for account based on which compute VNets are to be filtered.", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "associated_transit_vnet_id": {
      "description": "Identifier for filtering all the compute VNets which are NSX managed by the given transit VNet.", 
      "required": false, 
      "title": "Transit VNet ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which compute virtual networks list can be filtered. It consists of resourceGuid of Azure VNet.", 
      "required": false, 
      "title": "VNet ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AzureComputeVNetListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure compute virtual networks.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureComputeVNetListResult", 
  "module_id": "AzureVnetInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure compute virtual networks.", 
      "items": {
        "$ref": "AzureComputeVNetConfig
      }, 
      "required": false, 
      "title": "List of Compute VNets", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Compute VNet list", 
  "type": "object"
}

AzureComputeVnetStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores onboard and offboard status of Azure VNet. There are 4 states in onboarding a VNet using transit VNet and the corresponding states in sequence are VALIDATING_ENVIRONMENT, CREATING_SECURITY_GROUPS, CONFIGURING_GATEWAY and ONBOARD_SUCCESSFUL. There are 3 states in offboarding a VNet and the corresponding states in sequence are UNCONFIGURING_GATEWAY, DELETING_SECURITY_GROUPS and OFFBOARD_SUCCESSFUL. The state of failure in onboarding or offboarding is indicated by ONBOARD_FAILED and OFFBOARD_FAILED.", 
  "extends": {
    "$ref": "VirtualPrivateCloudStatus
  }, 
  "id": "AzureComputeVnetStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "configuration": {
      "$ref": "AzureVNetConfig, 
      "description": "Stores AZURE VNet configuration.", 
      "required": false, 
      "title": "AZURE VNet Config"
    }, 
    "error_code": {
      "description": "Error code related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Code", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Error message related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "offboard_step": {
      "description": "Stores the different states of virtual private cloud while offboarding from a transit virtual private cloud.", 
      "enum": [
        "UNCONFIGURING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "OFFBOARD_SUCCESSFUL", 
        "OFFBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While OffBoard", 
      "type": "string"
    }, 
    "onboard_step": {
      "description": "Stores the different states of virtual private cloud while onboarding using a transit virtual private cloud.", 
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "CREATING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "ONBOARD_SUCCESSFUL", 
        "ONBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While Onboard", 
      "type": "string"
    }, 
    "status": {
      "description": "Indicates the status of a virtual private cloud. UP: virtual private cloud is NSX managed. DOWN: virtual private cloud is NSX managed with errors. ONBOARDING: virtual private cloud is in the process of   onboarding using a transit virtual private cloud. OFFBOARDING: virtual private cloud is in the process of    offboarding from a transit virtual private cloud. NOT_APPLICABLE: virtual private cloud is NSX unmanaged.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ONBOARDING", 
        "OFFBOARDING", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Private Cloud Status", 
      "type": "string"
    }, 
    "virtual_private_cloud_name": {
      "description": "Name of the transit virtual private cloud.", 
      "readonly": true, 
      "title": "Virtual Private Cloud Name", 
      "type": "string"
    }
  }, 
  "title": "VNet Status", 
  "type": "object"
}

AzureCredentials (type)

{
  "additional_properties": false, 
  "description": "Stores information about Azure account credentials", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureCredentials", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "client_id": {
      "description": "Client ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Client ID", 
      "type": "string"
    }, 
    "gateway_role": {
      "description": "Default Azure Managed Service Identity role that will be set to the Cloud Gateways deployed in the Azure account. Based on the permissions in the role, the gateways will have access to resources in the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure role name for gateway", 
      "type": "string"
    }, 
    "key": {
      "description": "Key of the Azure account. Used only to take input. Will never be returned in any API response.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Azure Account Key", 
      "type": "secure_string"
    }, 
    "subscription_id": {
      "description": "Subscription ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Subscription ID", 
      "type": "string"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Tenant ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Account Credentials", 
  "type": "object"
}

AzureGatewayConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores Azure gateway configuration like image_id, ssh_key and gateway_ha_configuration.", 
  "extends": {
    "$ref": "GatewayConfig
  }, 
  "id": "AzureGatewayConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "auto_agent_install_enabled": {
      "default": false, 
      "description": "Flag to identify if NSX agent installation will be done automatically or not. As of now this is supported for Azure Cloud only. If the flag managed_without_agents is set to true, this property will be ignored.", 
      "required": false, 
      "title": "Auto Agent Install Enabled", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed.", 
      "required": false, 
      "title": "Id of cloud security group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to identify if default quarantine policy is enabled", 
      "type": "boolean"
    }, 
    "dns_settings": {
      "$ref": "DnsSettings, 
      "deprecated": true, 
      "description": "Settings related to Cloud gateway DNS configuration. This determines DNS configuration based on dns_mode.", 
      "title": "DNS settings"
    }, 
    "gateway_connectivity_mode": {
      "description": "Helps the user choose default connectivity mode that will be used between Cloud Service Manager and Gateway. PUBLIC IP: All the connections will go through the internet. When this mode is selected by the user, the user will have to select a public Ip address from the list of public IP's from the 'Public IP on Mgmt NIC' field. PRIVATE IP: All the connections will go through the VGW or any other configured VPN. When there is no input provided by the user, an attempt will be made using PRIVATE_IP (VGW) first and if that doesn't go through, an attempt will be made using PUBLIC_IP (IGW). And if both fail, it will cause an exception.", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "title": "Gateway Connectivity Mode", 
      "type": "string"
    }, 
    "gateway_ha_configuration": {
      "items": {
        "$ref": "AzureGatewayHaConfig
      }, 
      "required": false, 
      "title": "Azure Gateway HA configuration", 
      "type": "array"
    }, 
    "image_id": {
      "description": "The ID of the Public Cloud Gateway image in Azure", 
      "required": false, 
      "title": "NSX PCG Image ID", 
      "type": "string"
    }, 
    "image_id_obsolete": {
      "default": false, 
      "description": "If this flag is set, NSX was upgraded after the gateway was deployed and this image ID should no longer be used", 
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if the image ID is related to the previous NSX release", 
      "type": "boolean"
    }, 
    "is_ha_enabled": {
      "required": false, 
      "title": "Flag to identify if HA is enabled", 
      "type": "boolean"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this virtual private cloud is managed with or without NSX agents. This flag is applicable only for this network. If this virtual private cloud is being managed without NSX agents, quarantine state and threat state will be NOT_APPLICABLE for all the virtual machines under it.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "nsx_manager_connection": {
      "description": "Determines if connection to NSX Manager is via public IP or private IP", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "required": false, 
      "title": "NSX Manager connection", 
      "type": "string"
    }, 
    "proxy_server_profile": {
      "description": "Id of the proxy server profile, corresponding proxy settings will be applied while deploying the gateway.", 
      "required": false, 
      "title": "Id of the proxy server profile", 
      "type": "string"
    }, 
    "ssh_key": {
      "description": "This key will be associated to Public Cloud Gateway instance while it is launched in Azure.", 
      "required": false, 
      "title": "SSH Key", 
      "type": "string"
    }, 
    "storage_account_name": {
      "description": "Azure Storage Account where gateway image will be copied.", 
      "required": false, 
      "title": "Azure Storage Account Name", 
      "type": "string"
    }, 
    "target_disk_size": {
      "description": "This is the target disk size of the PCG appliance in GB. Based on this an additional disk is attached to the PCG appliance, if required. The supported size is 191 GB and this property should only be modified post upgrade for exisiting PCG appliances.", 
      "required": false, 
      "title": "Target Disk Size", 
      "type": "integer"
    }, 
    "vpn_service_enabled": {
      "default": true, 
      "description": "Flag that will enable or disable inter-operation between NSX and non-NSX services via VPN.", 
      "required": false, 
      "title": "Flag to enable or disable inter-operation with services via VPN", 
      "type": "boolean"
    }
  }, 
  "title": "Azure gateway configuration", 
  "type": "object"
}

AzureGatewayDeployConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores configuration for Azure gateway deployment request.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureGatewayDeployConfig", 
  "module_id": "AzureGatewayManagement", 
  "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"
    }, 
    "account_id": {
      "description": "ID of the Azure account.", 
      "required": true, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AzureGatewayConfig, 
      "description": "Configuration of Azure gateway.", 
      "readonly": false, 
      "required": true, 
      "title": "Azure Gateway Configuration"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Virtual Network. It consists of resourceGuid of Azure Vnet.", 
      "required": true, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway deployment configuration", 
  "type": "object"
}

AzureGatewayHaConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureGatewayHaConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "downlink_subnet": {
      "required": true, 
      "title": "Downlink subnet", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": true, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "management_subnet": {
      "required": true, 
      "title": "Management subnet", 
      "type": "string"
    }, 
    "private_ip_settings": {
      "$ref": "GatewayPrivateIp, 
      "description": "Stores settings related to Azure gateway Private IP configuration. The private_ip will be attached to management interface of the gateway, based on the value of ip_allocation_mode.", 
      "required": false, 
      "title": "Private IP settings for management interface"
    }, 
    "public_ip_settings": {
      "$ref": "GatewayPublicIp, 
      "description": "Stores settings related to Azure gateway Public IP configuration. The public_ip will be attached for management interface of the gateway.", 
      "required": false, 
      "title": "Public IP settings"
    }, 
    "uplink_public_ip_settings": {
      "$ref": "GatewayPublicIp, 
      "description": "Stores settings related to Azure gateway Public IP configuration. The public_ip will be attached to uplink interface of the primary gateway, based on the value of ip_allocation_mode.", 
      "required": false, 
      "title": "Public IP settings for uplink interface"
    }, 
    "uplink_subnet": {
      "required": true, 
      "title": "Uplink subnet", 
      "type": "string"
    }
  }, 
  "title": "Azure subnet configuration to deploy gateways", 
  "type": "object"
}

AzureGatewayInfo (type)

{
  "additionalProperties": false, 
  "description": "Stores azure gateway information like configuration and status.", 
  "id": "AzureGatewayInfo", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "configuration": {
      "$ref": "AzureGatewayConfig, 
      "description": "Configuration of Azure gateway.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Configuration"
    }, 
    "csm_ip_address": {
      "description": "Cloud service manager IP address used to communicate with the Azure VNet gateways.", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud service manager IP address", 
      "type": "string"
    }, 
    "gateway_status": {
      "$ref": "AzureGatewayStatus, 
      "description": "Array of gateway statuses.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status"
    }
  }, 
  "title": "Azure Gateway Information", 
  "type": "object"
}

AzureGatewayInstanceStatus (type)

{
  "description": "Stores information about Azure gateway instance status", 
  "extends": {
    "$ref": "GatewayInstanceStatus
  }, 
  "id": "AzureGatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "azure_image_bytes_copied": {
      "description": "Displays number of bytes copied, while copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Bytes copied, while copying image", 
      "type": "integer"
    }, 
    "azure_image_copy_progress": {
      "description": "Displays progress percentage while copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Progress Percentage for image copy", 
      "type": "integer"
    }, 
    "azure_image_total_bytes": {
      "description": "Displays total number of bytes required to be copied, for copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Total bytes required to be copied, for copying image", 
      "type": "integer"
    }, 
    "configuration_operation_status": {
      "$ref": "GatewayConfigOperationStatus, 
      "description": "This property provides a consolidated status of supported gateway configuration operations.", 
      "readonly": true, 
      "required": false, 
      "title": "Status of different gateway configuration operations"
    }, 
    "deployment_step": {
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "COPYING_IMAGE", 
        "CREATING_SECURITY_GROUPS", 
        "LAUNCHING_GATEWAY", 
        "CREATING_NETWORK_INTERFACES", 
        "ATTACHING_NETWORK_INTERFACES", 
        "ATTACHING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "CREATING_LOGICAL_NETWORK_CONSTRUCTS", 
        "DEPLOYMENT_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNCONFIGURING_GATEWAY", 
        "RELEASING_EIPS", 
        "TERMINATING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "DELETING_CLOUD_RESOURCES", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_FAILED", 
        "NOT_APPLICABLE", 
        "CLEANUP_INPROGRESS", 
        "CLEANUP_FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway operation failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway operation failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway instance status", 
  "type": "object"
}

AzureGatewayStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores Azure gateway status related information", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureGatewayStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "gateway_cluster_id": {
      "description": "Cluster ID of NSX gateway", 
      "required": false, 
      "title": "NSX gateway cluster ID", 
      "type": "string"
    }, 
    "gateway_instances_status": {
      "description": "Array of gateway instances statuses", 
      "items": {
        "$ref": "AzureGatewayInstanceStatus
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Instances Status", 
      "type": "array"
    }
  }, 
  "title": "Azure Gateway Status", 
  "type": "object"
}

AzureGatewayUndeployConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores configuration for Azure gateway undeployment request.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureGatewayUndeployConfig", 
  "module_id": "AzureGatewayManagement", 
  "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"
    }, 
    "account_id": {
      "description": "ID of the Azure account.", 
      "required": true, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "instance_id": {
      "description": "ID of the gateway instance.", 
      "required": true, 
      "title": "Azure Instance ID", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway undeployment configuration", 
  "type": "object"
}

AzureGatewaysListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure gateways. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureGatewaysListRequestParameters", 
  "module_id": "AzureGatewayManagement", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which Azure gateways list can be filtered.", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which Azure Gateways list can be filtered.", 
      "required": false, 
      "title": "Azure Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which Azure Gateways list can be filtered. It consists of resourceGuid of Azure Vnet.", 
      "required": false, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Gateways List Request Parameters", 
  "type": "object"
}

AzureGatewaysListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure gateways.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureGatewaysListResult", 
  "module_id": "AzureGatewayManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure gateways.", 
      "items": {
        "$ref": "AzureGatewayDeployConfig
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Gateways List Result", 
  "type": "object"
}

AzureIpAllocationConfig (type)

{
  "additionalProperties": false, 
  "description": "Azure cloud specific configuration parameters to create IP allocations for a Pivotal Application Service / Pivotal Cloud Foundry foundation.", 
  "extends": {
    "$ref": "CloudIpAllocationConfig
  }, 
  "id": "AzureIpAllocationConfig", 
  "module_id": "AzureIpManagement", 
  "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"
    }, 
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "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"
    }, 
    "ip_allocation_mode": {
      "default": "PUBLIC_IP", 
      "description": "PUBLIC_IP: Allocate new public IP. LINK_LOCAL_IP: Allocate new link local IP.", 
      "enum": [
        "PUBLIC_IP", 
        "LINK_LOCAL_IP"
      ], 
      "title": "IP Allocation Mode", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "number_of_allocations": {
      "desription": "The number of public/link local IP allocations requested.\n", 
      "readonly": false, 
      "required": true, 
      "title": "Number of IP allocations required.", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Vnet in which the IPs are allocated.", 
      "readonly": false, 
      "required": true, 
      "title": "Vnet ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud IP allocation configuration", 
  "type": "object"
}

AzureIpAllocationMappings (type)

{
  "additionalProperties": false, 
  "description": "Stores information about Cloud IP mapping for a Pivotal Application Service / Pivotal Cloud Foundry foundation.", 
  "extends": {
    "$ref": "CloudIpAllocationMappings
  }, 
  "id": "AzureIpAllocationMappings", 
  "module_id": "AzureIpManagement", 
  "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"
    }, 
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "readonly": true, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "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"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for IP allocation failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for IP allocation failure", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "readonly": true, 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "ip_mappings": {
      "description": "IP mappings for a foundation.", 
      "items": {
        "$ref": "CloudIpAllocationMapping
      }, 
      "readonly": true, 
      "type": "array"
    }, 
    "ip_operation_status": {
      "description": "Indicates the state of the IP allocation or de-allocation. ALLOCATION_IN_PROGRESS: IP allocation is in progress. DELETION_IN_PROGRESS: IP de-allocation or deletion is in progress. SUCCESSFUL: IP allocation is successful. Successful de-allocation can be confirmed if the status API for this mapping returns a 404 error. FAILED: IP allocation or de-allocation failed.", 
      "enum": [
        "ALLOCATION_IN_PROGRESS", 
        "DELETION_IN_PROGRESS", 
        "SUCCESSFUL", 
        "FAILED"
      ], 
      "readonly": true, 
      "title": "IP Allocation State", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Vnet in which the IPs are allocated.", 
      "readonly": true, 
      "title": "Vnet ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud IP allocation mappings", 
  "type": "object"
}

AzureIpMappingsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of IP allocation mappings. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "IpMappingsListRequestParameters
  }, 
  "id": "AzureIpMappingsListRequestParameters", 
  "module_id": "AzureIpManagement", 
  "properties": {
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "required": false, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Name of IP Mappings.", 
      "required": false, 
      "title": "Name of IP Mappings", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "required": false, 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "mapping_id": {
      "description": "ID of the mapping returned in IP allocation request.", 
      "required": false, 
      "title": "Mapping ID", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Vnet in which the IPs are allocated.", 
      "required": false, 
      "title": "Vnet ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AzureIpMappingsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Cloud IP mappings.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureIpMappingsListResult", 
  "module_id": "AzureIpManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Cloud public/link local IP to secondary IP mappings.", 
      "items": {
        "$ref": "AzureIpAllocationMappings
      }, 
      "required": false, 
      "title": "Cloud IP mappings Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud IP Mappings List Result", 
  "type": "object"
}

AzurePublicIpListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure Public IPs. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzurePublicIpListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which public IPs are to be filtered.", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which public IPs are to be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for \"nsx.vnet\" tag on which public IPs are to be filtered.", 
      "required": false, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Public IP List Request Parameters", 
  "type": "object"
}

AzurePublicIpListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure public IPs.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzurePublicIpListResult", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure Public IPs.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Azure Public IP", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Public IP List Result", 
  "type": "object"
}

AzureRegion (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure region.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AzureRegion", 
  "module_id": "AzureRegionInformation", 
  "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"
    }, 
    "associated_account_ids": {
      "description": "Array of associated Azure account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Azure Account IDs", 
      "type": "array"
    }, 
    "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"
    }, 
    "gateway_stats": {
      "$ref": "GatewayStats, 
      "description": "Stores statistics of the number of UP, DOWN and DEPLOYING gateways.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Statistics"
    }, 
    "has_managed_vnet": {
      "readonly": true, 
      "required": false, 
      "title": "Has a managed Virtual Network?", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of MANAGED, UNMANAGED and ERROR instances.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_stats": {
      "$ref": "VnetStats, 
      "description": "Stores statistics of the number of MANAGED and UNMANAGED virtual networks.", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Network Statistics"
    }
  }, 
  "title": "Azure Region Information", 
  "type": "object"
}

AzureRegionsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure regions. Multiple parameters can be given as input to use 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureRegionsListRequestParameters", 
  "module_id": "AzureRegionInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which regions list can be filtered.", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which the regions list can be filtered.", 
      "required": false, 
      "title": "Azure Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Regions List Request Parameters", 
  "type": "object"
}

AzureRegionsListResult (type)

{
  "additionalProperties": false, 
  "description": "A list of Azure regions.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureRegionsListResult", 
  "module_id": "AzureRegionInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure regions.", 
      "items": {
        "$ref": "AzureRegion
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Regions List Result", 
  "type": "object"
}

AzureResourceGroup (type)

{
  "additionalProperties": false, 
  "description": "Stores Azure resource group information.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureResourceGroup", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "resource_group_id": {
      "description": "Id of resource group.", 
      "required": false, 
      "title": "Id of resource group", 
      "type": "string"
    }, 
    "resource_group_name": {
      "description": "Name of resource group.", 
      "required": false, 
      "title": "Name of resource group", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource Group", 
  "type": "object"
}

AzureResourceGroupsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure resource groups.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureResourceGroupsListResult", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure resource groups.", 
      "items": {
        "$ref": "AzureResourceGroup
      }, 
      "required": true, 
      "title": "Azure resource groups Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource Groups List Result", 
  "type": "object"
}

AzureResourcesListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure resources. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "SecurityGroupListRequestParameters
  }, 
  "id": "AzureResourcesListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which resources are to be filtered.", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "is_managed_by_nsx": {
      "description": "Filter parameter to obtain security groups which are managed by NSX.", 
      "title": "Is Managed By NSX", 
      "type": "boolean"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources are to be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_group_id": {
      "description": "Optional identifier for resource group id based on which resources are to be filtered.", 
      "required": false, 
      "title": "Resource Group ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which resources are to be filtered.", 
      "required": false, 
      "title": "Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource List Request Parameters", 
  "type": "object"
}

AzureSecurityGroup (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure VNet security group.", 
  "extends": {
    "$ref": "CloudSecurityGroup
  }, 
  "id": "AzureSecurityGroup", 
  "module_id": "AzureResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "associated_vnet_ids": {
      "description": "Array of VNet IDs.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "VNet IDs", 
      "type": "array"
    }, 
    "cloud_tags": {
      "description": "Array of tags associated to a cloud security group.", 
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "title": "Cloud Tags", 
      "type": "array"
    }, 
    "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"
    }, 
    "inbound_rules": {
      "description": "Array of inbound rules of the Azure security group.", 
      "items": {
        "$ref": "AzureSecurityGroupRule
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Inbound Rules", 
      "type": "array"
    }, 
    "instances_count": {
      "description": "Number of instances associated to cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Count Of Instances", 
      "type": "integer"
    }, 
    "is_managed_by_nsx": {
      "description": "If the flag is true, the cloud security group is managed by NSX.", 
      "readonly": true, 
      "required": false, 
      "title": "Is Managed By NSX", 
      "type": "boolean"
    }, 
    "nsx_security_group_mapping": {
      "description": "Map of cloud application security groups associated to this Azure network security group and corresponding NSX security groups.", 
      "items": {
        "$ref": "SecurityGroupDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Group Mapping", 
      "type": "array"
    }, 
    "outbound_rules": {
      "description": "Array of outbound rules of the Azure security group.", 
      "items": {
        "$ref": "AzureSecurityGroupRule
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Outbound Rules", 
      "type": "array"
    }, 
    "region_id": {
      "description": "ID of the cloud region.", 
      "readonly": true, 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_group_name": {
      "description": "Name of the Azure resource group.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource Group Name", 
      "type": "string"
    }, 
    "resource_id": {
      "description": "Resource ID of Azure Network Security Group.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Azure VNet Security Group", 
  "type": "object"
}

AzureSecurityGroupRule (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure security group rule.", 
  "extends": {
    "$ref": "CloudSecurityGroupRule
  }, 
  "id": "AzureSecurityGroupRule", 
  "module_id": "AzureResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "action": {
      "description": "Action configured for the Azure security group rule.", 
      "enum": [
        "ALLOW", 
        "DENY"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination": {
      "description": "Destination corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Destination", 
      "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"
    }, 
    "port_range": {
      "description": "Port range corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Port Range", 
      "type": "string"
    }, 
    "priority": {
      "description": "Priority of the Azure security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Priority", 
      "type": "integer"
    }, 
    "protocol": {
      "description": "Protocol corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Protocol", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "source": {
      "description": "Source corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Source", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Azure Security Group Rule", 
  "type": "object"
}

AzureSecurityGroupsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure security groups.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureSecurityGroupsListResult", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure security groups.", 
      "items": {
        "$ref": "AzureSecurityGroup
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Security Groups List Result", 
  "type": "object"
}

AzureServiceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Stores endpoint information about any service which is provided by Azure. NSX supported services are currently limited to Azure Storage, Azure SQL Database, Azure Cosmos DB and Azure Load Balancer.", 
  "extends": {
    "$ref": "CloudServiceEndpoint
  }, 
  "id": "AzureServiceEndpoint", 
  "module_id": "AzureVnetResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "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"
    }, 
    "nsx_security_groups": {
      "description": "Stores an array of NSX security groups associated to this cloud service endpoint.", 
      "items": {
        "$ref": "SecurityGroup
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX security groups array", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_endpoint_id": {
      "description": "Cloud provided ID of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint ID", 
      "type": "string"
    }, 
    "service_endpoint_type": {
      "description": "Cloud provided type of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint Type", 
      "type": "string"
    }, 
    "service_name": {
      "description": "Name of the cloud service the endpoint is associated with.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Name", 
      "type": "string"
    }, 
    "service_type": {
      "description": "Stores the type of Azure service corresponding to this endpoint. AZURE_COSMOSDB - Azure Cosmos DB AZURE_SQL - Azure SQL Database AZURE_STORAGE - Azure Storage AZURE_LOAD_BALANCER - Azure Load Balancer", 
      "enum": [
        "AZURE_COSMOSDB", 
        "AZURE_SQL", 
        "AZURE_STORAGE", 
        "AZURE_LOAD_BALANCER"
      ], 
      "readonly": true, 
      "title": "Service type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Azure Service Endpoint", 
  "type": "object"
}

AzureServiceEndpointsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of Azure service endpoints. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureServiceEndpointsListRequestParameters", 
  "module_id": "AzureVnetResources", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "service_endpoint_id": {
      "description": "Optional ID of Azure service endpoint based on which the list of service endpoints are to be filtered.", 
      "required": false, 
      "title": "Azure Service Endpoint ID", 
      "type": "string"
    }, 
    "service_name": {
      "description": "Optional name of Azure service based on which the list of service endpoints are to be filtered.", 
      "required": false, 
      "title": "Azure Service Name", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AzureServiceEndpointsListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of service endpoints which are provided by Azure with information about each of them. NSX supported services are currently limited to Azure\u00a0Storage, Azure SQL Database, Azure Cosmos DB and Azure Load Balancer.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureServiceEndpointsListResult", 
  "module_id": "AzureVnetResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure service endpoints.", 
      "items": {
        "$ref": "AzureServiceEndpoint
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Service Endpoints List Result", 
  "type": "object"
}

AzureStorageAccount (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AzureStorageAccount", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the Azure Storage Account", 
      "type": "string"
    }
  }, 
  "title": "Azure Storage Account", 
  "type": "object"
}

AzureStorageAccountList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureStorageAccountList", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AzureStorageAccount
      }, 
      "required": false, 
      "title": "Azure Storage Accounts list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Azure Storage Accounts", 
  "type": "object"
}

AzureStorageAccountsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of storage accounts. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureStorageAccountsListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which list of storage accounts will be obtained\n", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": true, 
      "title": "Identifier for region based on which list of storage accounts will be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AzureSubnet (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure subnet.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "AzureSubnet", 
  "module_id": "AzureResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "address_space": {
      "description": "Address space of the subnet in IPv4 CIDR block format.", 
      "format": "ipv4-cidr-block", 
      "readonly": true, 
      "title": "Azure subnet address space", 
      "type": "string"
    }, 
    "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": {
      "desription": "Stores the ID of the subnet.", 
      "readonly": true, 
      "title": "ID of Subnet", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Virtual Network.It consists of resourceGuid of Azure Vnet.", 
      "readonly": true, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Subnet", 
  "type": "object"
}

AzureSubnetListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure subnets. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureSubnetListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which subnets are to be filtered.", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. region_id will be learnt from vnet_id information.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Identifier for vnet based on which subnets are to be filtered. It consists of resourceGuid of Azure Vnet.", 
      "required": true, 
      "title": "Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Subnet List Request Parameters", 
  "type": "object"
}

AzureSubnetListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure subnets.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureSubnetListResult", 
  "module_id": "AzureResources", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure subnets.", 
      "items": {
        "$ref": "AzureSubnet
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure subnets List Result", 
  "type": "object"
}

AzureTransitVnetConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the account IDs and VNet ID related to the transit VNet.", 
  "id": "AzureTransitVnetConfig", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "account_id": {
      "deprecated": true, 
      "description": "Azure account ID of the transit VNet. This field is deprecated. Field account_id can be learnt using vnet_id. GET /csm/azure/vnets/<vnet-id> API returns associated_account_ids. Hence, this field is optional.", 
      "required": false, 
      "title": "Azure account ID", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "VNet ID of the transit VNet.", 
      "required": true, 
      "title": "VNet ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Transit VNet Configuration", 
  "type": "object"
}

AzureTransitVnetInfo (type)

{
  "description": "Stores the account ID and VNet ID related to the transit VNet. A transit VNet is a Azure VNet in which public cloud gateways are deployed and is managing the workload VMs present in other compute VNets.", 
  "extends": {
    "$ref": "VirtualPrivateCloudInfo
  }, 
  "id": "AzureTransitVnetInfo", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "associated_account_ids": {
      "description": "Cloud account ID related to the virtual private cloud.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Array of Cloud Account IDs", 
      "type": "array"
    }, 
    "virtual_private_cloud_id": {
      "description": "Virtual private cloud ID of the corresponding cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Private Cloud ID", 
      "type": "string"
    }, 
    "virtual_private_cloud_name": {
      "description": "Virtual private cloud name of the corresponding cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Private Cloud name", 
      "type": "string"
    }
  }, 
  "title": "Azure Transit VNet Information", 
  "type": "object"
}

AzureVNetConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the configuration such as default_quarantine_policy_enabled, cloud_fallback_security_group_id and auto_agent_install_enabled for correponding AZURE VNet.", 
  "extends": {
    "$ref": "VirtualPrivateCloudConfig
  }, 
  "id": "AzureVNetConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "auto_agent_install_enabled": {
      "default": false, 
      "description": "Flag to identify if NSX agent installation will be done automatically or not. As of now this is supported for Azure Cloud only. If the flag managed_without_agents is set to true, this property will be ignored.", 
      "required": false, 
      "title": "Auto Agent Install Enabled", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.", 
      "title": "Id of Cloud Security Group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "description": "Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.", 
      "title": "Flag to Identify if Default Quarantine Policy is Enabled", 
      "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"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this compute virtual private cloud is managed with or without NSX agents.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AZURE VNet Configuration", 
  "type": "object"
}

AzureVirtualMachine (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a Azure Virtual Machine", 
  "extends": {
    "$ref": "CloudVirtualMachine
  }, 
  "id": "AzureVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AzureVirtualMachine"
  }, 
  "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"
    }, 
    "agent_status": {
      "description": "UP - NSX Agent is up and running DOWN - NSX Agent is down NO_AGENT - No NSX Agent installed on instance UNKNOWN - NSX Agent status is unknown NEEDS_UPDATE - NSX Agent running on instance needs to be updated", 
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT", 
        "UNKNOWN", 
        "NEEDS_UPDATE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "cloud_instance_type": {
      "description": "This field represents various type of service instances in cloud. VIRTUAL_MACHINE: Virtual machine deployed in public cloud. AWS_RDS_INSTANCE: Amazon Relational Database Service Instance. AWS_RDS_CLUSTER: Amazon Relational Database Service Cluster. AWS_APPLICATION_ELB_INSTANCE: Amazon Application Elastic LoadBalancer. AWS_CLASSIC_ELB_INSTANCE: Amazon Classic Elastic LoadBalancer. HORIZON_MANAGEMENT: Virtual Machines that are deployed on Microsoft Azure using Horizon Cloud Services(HCS) that are used for managing other instances in the network. This includes, Management VMs, Unified Access Gateway (UAG) VMs, Base VMs. HORIZON_VDI: Virtual Desktop Image (VDI) deployed on Microsoft Azure using Horizon Cloud Services(HCS).", 
      "enum": [
        "VIRTUAL_MACHINE", 
        "AWS_RDS_INSTANCE", 
        "AWS_RDS_CLUSTER", 
        "AWS_APPLICATION_ELB_INSTANCE", 
        "AWS_CLASSIC_ELB_INSTANCE", 
        "HORIZON_MANAGEMENT", 
        "HORIZON_VDI"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Instance Type", 
      "type": "string"
    }, 
    "cloud_network_security_group": {
      "$ref": "SecurityGroup, 
      "description": "Stores information about the cloud network security group associated to the virtual machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Network Security Group"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the instance", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages identified in the last 1 hour.", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway.", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if instance is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_failed_rules_count": {
      "description": "Number of NSX firewall rules failed to realize on cloud for the instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX failed rules count", 
      "type": "integer"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "nsx_security_group_mapping": {
      "description": "Map of cloud security groups associated to the instance and corresponding NSX security groups.", 
      "items": {
        "$ref": "SecurityGroupDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Group Mapping", 
      "type": "array"
    }, 
    "nsx_security_rule_errors": {
      "deprecated": true, 
      "description": "DEPRECATED. Array of NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "items": {
        "$ref": "NsxSecurityRuleErrorDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors", 
      "type": "array"
    }, 
    "nsx_security_rule_errors_count": {
      "deprecated": true, 
      "description": "DEPRECATED. Count of the NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors Count", 
      "type": "integer"
    }, 
    "nsx_successful_rules_count": {
      "description": "Number of NSX firewall rules successfully configured for this instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX successful rules count", 
      "type": "integer"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the instance", 
      "type": "string"
    }, 
    "power_state": {
      "description": "Indicates power state of the virtual machine as returned by Azure.", 
      "enum": [
        "RUNNING", 
        "DEALLOCATING", 
        "DEALLOCATED", 
        "STARTING", 
        "STOPPED", 
        "STOPPING", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Power State", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the instance", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the instance", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the instance. QUARANTINED - This state implies instance is moved to quarantine security group because some threat has been detected. NOT_QUARANTINED - This state implies no quarantine action has been taken. UNKNOWN - This state implies either quarantine policy is disabled or quarantine information is not available. OVERRIDDEN - This state implies instance is associated with vm_override_sg which overrides any action based on threat detection. WHITELISTED - This state implies that quarantine operation will not be performed on the instance [DEPRECATED - replaced with USERMANAGED]. USERMANAGED - This state implies that quarantine operation will not be performed on the instance. NOT_APPLICABLE - This state will be populated for agentless instance, Horizon Management instance.", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN", 
        "WHITELISTED", 
        "USERMANAGED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region": {
      "description": "Azure region in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "Azure region", 
      "type": "string"
    }, 
    "resource_group": {
      "description": "Resource Group of the Azure Virtual Machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource Group", 
      "type": "string"
    }, 
    "resource_id": {
      "description": "Resource Id of Azure Virtual Machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Virtual Machine resource id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of VirtualMachine prefixed by cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "segment_display_name": {
      "description": "Segment display name on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment display name", 
      "type": "string"
    }, 
    "segment_id": {
      "description": "Segment ID on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment ID", 
      "type": "string"
    }, 
    "status": {
      "description": "POWERED_ON - Powered on instance POWERED_OFF - Powered off instance MANAGED_GATEWAY - Instances that are public cloud gateways MANAGED - Instances that are managed by NSX UNMANAGED - Instances that are not managed by NSX or untagged ERRORED - Instances with no NSX Agent connectivity, NSX Agent is down, No NSX Policy configured for Agentless VMs or Error on NSX Policy rule realization. QUARANTINED - Instances which have been quarantined WHITELISTED - Instances which have been whitelisted [DEPRECATED - replaced with USERMANAGED] USERMANAGED - Instances which have been marked as usermanaged.", 
      "enum": [
        "POWERED_ON", 
        "POWERED_OFF", 
        "UNMANAGED", 
        "MANAGED_GATEWAY", 
        "MANAGED", 
        "ERRORED", 
        "QUARANTINED", 
        "WHITELISTED", 
        "USERMANAGED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Instance status", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the instance. NORMAL - This state implies no threat has been detected and instance is functioning as expected. THREAT - This state implies quarantine enabling threat has been detected. INVALID - This state implies either instance is unmanaged or threat related information is not available. NOT_APPLICABLE - This state will be populated for agentless instance.", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_config_status": {
      "$ref": "VmConfigStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Status for user configurable properties"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available           regarding extension execution. This can potentially occur for           a VM when agent is installed out of band or if           cloud_agent_automated_install_enabled flag is enabled for the           VNET/VPC which already has managed VMs. SUCCESSFUL - Indicates VM extension script execution was successful.           This does not necessarily mean agent installation was           successful. FAILED - Indicates VM extension script execution failed.", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }, 
    "vnet": {
      "description": "Azure virtual network ID in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "Azure virtual network", 
      "type": "string"
    }, 
    "vnet_name": {
      "description": "Azure virtual network name in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "Azure virtual network name", 
      "type": "string"
    }
  }, 
  "title": "Azure Virtual Machine Information", 
  "type": "object"
}

AzureVnet (type)

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure VNet (Virtual Network).", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "AzureVnet", 
  "module_id": "AzureVnetInformation", 
  "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"
    }, 
    "agent_info": {
      "description": "Array of agent install and download instructions for various OS types.", 
      "items": {
        "$ref": "AgentInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Azure Agent Information", 
      "type": "array"
    }, 
    "associated_account_ids": {
      "description": "Array of associated Azure account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Azure Account IDs", 
      "type": "array"
    }, 
    "associated_transit_vnet": {
      "$ref": "AzureTransitVnetInfo, 
      "description": "Stores the VNet ID and associated account IDs of the transit VNet. This property describes the associated transit VNet for a given Azure compute VNet.", 
      "readonly": true, 
      "title": "Associated Azure Transit VNet"
    }, 
    "capabilities": {
      "description": "This parameter will list out all external services and/or any other capabilities that are discovered by NSX on this virtual network. The array is empty by default.", 
      "items": {
        "description": "HORIZON - Horizon pod is deployed on this virtual network\n", 
        "enum": [
          "HORIZON"
        ], 
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of external capabilities that are discovered on this virtual network", 
      "type": "array"
    }, 
    "cidr_blocks": {
      "description": "IPv4 CIDR Block of the virtual network.", 
      "items": {
        "$ref": "CidrBlock
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPv4 CIDR Block", 
      "type": "array"
    }, 
    "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"
    }, 
    "gateway_info": {
      "$ref": "AzureGatewayInfo, 
      "description": "Gateway information of the virtual network like configuration and status.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Info"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of MANAGED, UNMANAGED, ERRORED and POWERED_OFF instances.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "is_management_vnet": {
      "default": false, 
      "description": "This flag indicates if this is a management virtual network.", 
      "readonly": true, 
      "required": false, 
      "title": "Is Management VNet?", 
      "type": "boolean"
    }, 
    "managed_vnets": {
      "description": "Array of compute VNets managed by a transit VNet. This property describes array of managed compute VNet for a given transit VNet.", 
      "items": {
        "$ref": "ManagedVnetInfo
      }, 
      "readonly": true, 
      "title": "Array of NSX Managed Compute VNets", 
      "type": "array"
    }, 
    "op_status": {
      "$ref": "AzureVnetOpStatus, 
      "description": "Operational status of the virtual network.", 
      "readonly": true, 
      "title": "Azure VNet Operational Status"
    }, 
    "region_id": {
      "description": "ID of the Azure region.", 
      "readonly": true, 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_group": {
      "description": "Resource Group of the Azure VNet.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource Group", 
      "type": "string"
    }, 
    "resource_id": {
      "description": "Resource Id of Azure VNet.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure VNet resource id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "storage_account_name": {
      "description": "Azure Storage Account where gateway image will be copied.", 
      "required": false, 
      "title": "Azure Storage Account Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zones": {
      "description": "Array of transport zones in the virtual network.", 
      "items": {
        "$ref": "TransportZoneInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Transport Zones", 
      "type": "array"
    }, 
    "vdi_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of Horizon desktops in different states such as MANAGED, UNMANAGED, ERRORED and POWERED_OFF", 
      "readonly": true, 
      "required": false, 
      "title": "Horizon VDI Statistics"
    }, 
    "vnet_status": {
      "$ref": "AzureComputeVnetStatus, 
      "description": "Stores onboard and offboard states and corresponding error messages and error code related to Azure compute VNet. The status for a transit VNet should be obtained from gateway_info.", 
      "readonly": true, 
      "title": "Azure Compute VNet Status"
    }
  }, 
  "title": "Azure VNet", 
  "type": "object"
}

AzureVnetListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure virtual networks. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AzureVnetListRequestParameters", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which virtual networks list can be filtered.", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "associated_transit_vnet_id": {
      "description": "Identifier for filtering all the compute VNets which are NSX managed by the given transit VNet.", 
      "required": false, 
      "title": "Transit VNet ID", 
      "type": "string"
    }, 
    "cidr": {
      "$ref": "CidrBlock, 
      "description": "Optional identifier for IPv4 CIDR Block based on which virtual networks list can be filtered.", 
      "required": false, 
      "title": "IPv4 CIDR Block"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "op_status": {
      "$ref": "AzureVnetOpStatus, 
      "description": "Operational status of the virtual network.", 
      "readonly": true, 
      "title": "Azure VNet Operational Status"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which virtual networks list can be filtered.", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status_filter": {
      "description": "MANAGED - VNet is managed by NSX UNMANAGED - VNet is not managed by NSX ERRORED - VNet is in error state", 
      "enum": [
        "MANAGED", 
        "UNMANAGED", 
        "ERRORED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Filter by overall VNet status", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which virtual networks list can be filtered. It consists of resourceGuid of Azure VNet.", 
      "required": false, 
      "title": "Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure VNet List Request Parameters", 
  "type": "object"
}

AzureVnetListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure virtual networks.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "AzureVnetListResult", 
  "module_id": "AzureVnetInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure virtual networks.", 
      "items": {
        "$ref": "AzureVnet
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure VNet List Result", 
  "type": "object"
}

AzureVnetOpStatus (type)

{
  "description": "Operational status of the azure virtual network. After there are gateways deployed in a VNet, that VNet is called as transit VNet and it's status will be set as NSX_MANAGED_BY_GATEWAY. For all the compute VNets which are being managed by a transit VNet, their status will be set as NSX_MANAGED_BY_TRANSIT_VNET. NSX_GATEWAY_ERROR status means gateways are deployed in VNet, but no gateway is UP and at least one gateway is DOWN, The remaining gateway can be in NOT_AVAILABLE state. NSX_COMPUTE_ERROR status will be shown in compute VNet when transit VNet is in NSX_GATEWAY_ERROR state. Status for all the rest of the VNets will be NSX_UNMANAGED. NSX_MANAGED is deprecated.", 
  "enum": [
    "NSX_MANAGED_BY_GATEWAY", 
    "NSX_MANAGED_BY_TRANSIT_VNET", 
    "NSX_MANAGED", 
    "NSX_UNMANAGED", 
    "NSX_GATEWAY_ERROR", 
    "NSX_COMPUTE_ERROR"
  ], 
  "id": "AzureVnetOpStatus", 
  "module_id": "CloudServiceManager", 
  "readonly": true, 
  "required": false, 
  "title": "Operational Status", 
  "type": "string"
}

BFDDiagnosticCount (type)

{
  "additionalProperties": false, 
  "id": "BFDDiagnosticCount", 
  "module_id": "Heatmap", 
  "properties": {
    "administratively_down_count": {
      "description": "Number of tunnels with administratively down diagnostic message", 
      "title": "Number of tunnels with administratively message", 
      "type": "integer"
    }, 
    "concatenated_path_down_count": {
      "description": "Number of tunnels with concatenated path down diagnostic message", 
      "title": "Number of tunnels with concatenated message", 
      "type": "integer"
    }, 
    "control_detection_time_expired_count": {
      "description": "Number of tunnels with control detection time expired diagnostic message", 
      "title": "Number of tunnels with expired message", 
      "type": "integer"
    }, 
    "echo_function_failed_count": {
      "description": "Number of tunnels with echo function failed diagnostic message", 
      "title": "Number of tunnels with failed message", 
      "type": "integer"
    }, 
    "forwarding_plane_reset_count": {
      "description": "Number of tunnels with forwarding plane reset diagnostic message", 
      "title": "Number of tunnels with reset message", 
      "type": "integer"
    }, 
    "neighbor_signaled_session_down_count": {
      "title": "Number of tunnels neighbor signaled session down", 
      "type": "integer"
    }, 
    "no_diagnostic_count": {
      "title": "Number of tunnels with no diagnostic", 
      "type": "integer"
    }, 
    "path_down_count": {
      "description": "Number of tunnels with path down diagnostic message", 
      "title": "Number of tunnels with path down message", 
      "type": "integer"
    }, 
    "reverse_concatenated_path_down_count": {
      "description": "Number of tunnels with reverse concatenated path down diagnostic message", 
      "title": "Number of tunnels with reverse message", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

BFDProperties (type)

{
  "additionalProperties": false, 
  "id": "BFDProperties", 
  "module_id": "Tunnel", 
  "properties": {
    "active": {
      "readonly": true, 
      "required": false, 
      "title": "True if tunnel is active in a gateway HA setup", 
      "type": "boolean"
    }, 
    "bfd_encap": {
      "description": "The encapsulation type of BFD. GENEVE        - BFD with GENEVE encapsulation NONE          - BFD with no encapsulation UNKNOWN_ENCAP - BFD with unknown encapsulation", 
      "enum": [
        "GENEVE", 
        "NONE", 
        "UNKNOWN_ENCAP"
      ], 
      "title": "BFD encapsulation type", 
      "type": "string"
    }, 
    "diagnostic": {
      "description": "A short message indicating what the BFD session thinks is wrong in case of a problem", 
      "readonly": true, 
      "required": false, 
      "title": "Diagnostic message of a problem", 
      "type": "string"
    }, 
    "forwarding": {
      "readonly": true, 
      "required": false, 
      "title": "True if the BFD session believes this interface may be used to forward traffic", 
      "type": "boolean"
    }, 
    "remote_diagnostic": {
      "description": "A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem", 
      "readonly": true, 
      "required": false, 
      "title": "Diagnostic message of a problem", 
      "type": "string"
    }, 
    "remote_state": {
      "enum": [
        "UNKNOWN_STATE", 
        "ADMIN_DOWN", 
        "DOWN", 
        "INIT", 
        "UP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of the remote interface's BFD session", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNKNOWN_STATE", 
        "ADMIN_DOWN", 
        "DOWN", 
        "INIT", 
        "UP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of the BFD session", 
      "type": "string"
    }
  }, 
  "title": "BFD information", 
  "type": "object"
}

BFDStatusCount (type)

{
  "additionalProperties": false, 
  "id": "BFDStatusCount", 
  "module_id": "Heatmap", 
  "properties": {
    "bfd_admin_down_count": {
      "title": "Number of tunnels in BFD admin down state", 
      "type": "int"
    }, 
    "bfd_down_count": {
      "title": "Number of tunnels in BFD down state", 
      "type": "int"
    }, 
    "bfd_init_count": {
      "title": "Number of tunnels in BFD init state", 
      "type": "int"
    }, 
    "bfd_up_count": {
      "title": "Number of tunnels in BFD up state", 
      "type": "int"
    }
  }, 
  "type": "object"
}

BGPCommunityList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BGPCommunityList", 
  "module_id": "Routing", 
  "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"
    }, 
    "communities": {
      "description": "Array of BGP communities", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "BGP community list", 
      "type": "array"
    }, 
    "community_type": {
      "default": "NormalBGPCommunity", 
      "description": "BGP community type. It has two types as NormalBGPCommunity BGP normal community which includes well-known community name as well as community value in range from [1-4294967295] or value in aa:nn format(aa/nn range from 1-65535). LargeBGPCommunity BGP large community which includes community value in aa:bb:nn format where aa, bb, nn are unsigned integers in the range [1-4294967295].", 
      "enum": [
        "NormalBGPCommunity", 
        "LargeBGPCommunity"
      ], 
      "title": "BGP community type", 
      "type": "string"
    }, 
    "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"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BGPCommunityListListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BGPCommunityListListResult", 
  "module_id": "Routing", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paginated list of bgp community lists", 
      "items": {
        "$ref": "BGPCommunityList
      }, 
      "required": false, 
      "title": "List of bgp communities", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BMSGroupAssociationRequestParams (type)

{
  "additionalProperties": false, 
  "description": "List request parameters containing Physical server external ID and enforcement point path", 
  "extends": {
    "$ref": "RealizationListRequestParameters
  }, 
  "id": "BMSGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "physical_server_external_id": {
      "required": true, 
      "title": "Physical external ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing Physical server external ID and enforcement point path", 
  "type": "object"
}

BackupConfiguration (type)

{
  "additionalProperties": false, 
  "id": "BackupConfiguration", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "after_inventory_update_interval": {
      "maximum": 86400, 
      "minimum": 300, 
      "required": false, 
      "title": "A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.", 
      "type": "integer"
    }, 
    "backup_enabled": {
      "default": false, 
      "title": "true if automated backup is enabled", 
      "type": "boolean"
    }, 
    "backup_schedule": {
      "$ref": "BackupSchedule, 
      "title": "Set when backups should be taken - on a weekly schedule or at regular intervals."
    }, 
    "inventory_summary_interval": {
      "default": 240, 
      "maximum": 3600, 
      "minimum": 30, 
      "title": "The minimum number of seconds between each upload of the inventory summary to backup server.", 
      "type": "integer"
    }, 
    "passphrase": {
      "description": "Passphrase used to encrypt backup files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (any other non-space character).", 
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup files.", 
      "type": "secure_string"
    }, 
    "remote_file_server": {
      "$ref": "RemoteFileServer, 
      "required": false, 
      "title": "The server to which backups will be sent."
    }
  }, 
  "title": "Configuration for taking manual/automated backup", 
  "type": "object"
}

BackupFrameRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameters (site_id, etc), that describes a backup/restore frame", 
  "id": "BackupFrameRequestParameters", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "frame_type": {
      "default": "LOCAL_LOCAL_MANAGER", 
      "description": "This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.", 
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Frame type", 
      "type": "string"
    }, 
    "site_id": {
      "default": "localhost", 
      "description": "Site ID of LM site, which will be supported in a frame", 
      "required": false, 
      "title": "Site ID", 
      "type": "string"
    }
  }, 
  "title": "Backup Frame Request Parameters", 
  "type": "object"
}

BackupOperationHistory (type)

{
  "additionalProperties": false, 
  "id": "BackupOperationHistory", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "cluster_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous cluser backups", 
      "type": "array"
    }, 
    "inventory_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous inventory backups", 
      "type": "array"
    }, 
    "node_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous node backups", 
      "type": "array"
    }
  }, 
  "title": "Past backup operation details", 
  "type": "object"
}

BackupOperationStatus (type)

{
  "additionalProperties": false, 
  "id": "BackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": true, 
      "title": "Unique identifier of a backup", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was ended"
    }, 
    "error_code": {
      "enum": [
        "BACKUP_NOT_RUN_ON_MASTER", 
        "BACKUP_SERVER_UNREACHABLE", 
        "BACKUP_AUTHENTICATION_FAILURE", 
        "BACKUP_PERMISSION_ERROR", 
        "BACKUP_TIMEOUT", 
        "BACKUP_BAD_FINGERPRINT", 
        "BACKUP_GENERIC_ERROR", 
        "UPGRADE_IN_PROGRESS"
      ], 
      "required": false, 
      "title": "Error code", 
      "type": "string"
    }, 
    "error_message": {
      "required": false, 
      "title": "Error code details", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was started"
    }, 
    "success": {
      "required": true, 
      "title": "True if backup is successfully completed, else false", 
      "type": "boolean"
    }
  }, 
  "readOnly": true, 
  "title": "Backup operation status", 
  "type": "object"
}

BackupOverview (type)

{
  "description": "Data for a single backup/restore card", 
  "extends": {
    "$ref": "ClusterBackupInfoListResult
  }, 
  "id": "BackupOverview", 
  "module_id": "BackupConfiguration", 
  "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"
    }, 
    "backup_config": {
      "$ref": "BackupConfiguration, 
      "description": "Configuration to generate a manual/automated backup", 
      "required": true, 
      "title": "Backup configuration"
    }, 
    "backup_operation_history": {
      "$ref": "BackupOperationHistory, 
      "description": "Status of the last backup execution per component", 
      "required": true, 
      "title": "Last backup status"
    }, 
    "current_backup_operation_status": {
      "$ref": "CurrentBackupOperationStatus, 
      "description": "Backup status decribes type, phase, success/failure and time of a | latest backup execution", 
      "required": true, 
      "title": "Current backup status"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "restore_status": {
      "$ref": "ClusterRestoreStatus, 
      "description": "Status of restore process executing/executed on appliance", 
      "required": true, 
      "title": "Current restore status"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of timestamps of backed-up cluster files", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Backup overview", 
  "type": "object"
}

BackupOverviewRequestParameters (type)

{
  "description": "Parameters, that REST API client needs to provide, in order to get data for a backup/restore card with or without a list of generated backups.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BackupOverviewRequestParameters", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "frame_type": {
      "default": "LOCAL_LOCAL_MANAGER", 
      "description": "This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.", 
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Frame type", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "show_backups_list": {
      "default": true, 
      "description": "True to request a list of backups", 
      "required": false, 
      "title": "Need a list of backups", 
      "type": "boolean"
    }, 
    "site_id": {
      "default": "localhost", 
      "description": "UUID of LM site, which will be supported in a frame", 
      "required": false, 
      "title": "UUID of the site", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Backup overview request parameters", 
  "type": "object"
}

BackupSchedule (type)

{
  "abstract": true, 
  "id": "BackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for Weekly or Interval Backup Schedule", 
  "type": "object"
}

BackupUiFramesInfo (type)

{
  "id": "BackupUiFramesInfo", 
  "properties": {
    "active_gm": {
      "enum": [
        "ACTIVE", 
        "STANDBY", 
        "NONE", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Does site have active GM", 
      "type": "string"
    }, 
    "api_endpoint": {
      "enum": [
        "global-manager", 
        "nsxapi", 
        "ica"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "prefix to be used for api call", 
      "type": "string"
    }, 
    "frame_type": {
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "help_detail": "This attribute is used to indicate the service on current\nsite or other site for which backup is handled.\nLOCAL_LOCAL_MANAGER corresponds to local LM of the site.\nLOCAL_MANAGER cprresponds to LM of other site.\n", 
      "readonly": true, 
      "required": true, 
      "title": "Type of service, for which backup is handled", 
      "type": "string"
    }, 
    "site_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the site", 
      "type": "string"
    }, 
    "site_version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of the site", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BackupUiFramesInfoList (type)

{
  "id": "BackupUiFramesInfoList", 
  "properties": {
    "backup_frames_list": {
      "items": {
        "$ref": "BackupUiFramesInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of backup frames(and metadata) to be displayed in UI", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseConsolidatedStatusPerEnforcementPoint (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Consolidated Realized Status Per Enforcement Point.", 
  "extends": {
    "$ref": "PolicyRuntimeInfoPerEP
  }, 
  "id": "BaseConsolidatedStatusPerEnforcementPoint", 
  "module_id": "PolicyRealizedState", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "Base class for ConsolidatedStatusPerEnforcementPoint", 
  "type": "object"
}

BaseEdgeStatisticsRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "BaseEdgeStatisticsRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "host_transport_node_path": {
      "description": "Policy path of host transport node. In case of API used from Global Manager, use the HostTransportNode path from Local Manager.", 
      "title": "Policy path of host transport node", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

BaseEndpoint (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an endpoint which will be used as subject in rule. It is a polymorphic type object which can be either of the types - 1. Virtual 2. Logical We have 2 separate objects representing these 2 types. VirtualEndPoint for Virtual type and ServiceInstanceEndpoint for Logical.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "VirtualEndpoint", 
        "ServiceInstanceEndpoint"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_ips": {
      "description": "IPs where either inbound or outbound traffic is to be redirected.", 
      "items": {
        "$ref": "IPInfo
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP addresses to redirect the traffic to", 
      "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": "An endpoint to be used in redirection rule", 
  "type": "object"
}

BaseFirewallProfile (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BaseFirewallProfile", 
  "module_id": "FirewallProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "Resource type to use as profile type", 
      "enum": [
        "FirewallSessionTimerProfile", 
        "FirewallCpuMemThresholdsProfile", 
        "FirewallFloodProtectionProfile", 
        "FirewallDnsProfile", 
        "GeneralSecuritySettingsProfile"
      ], 
      "help_summary": "Possible values are 'FirewallSessionTimerProfile',\n'FirewallCpuMemThresholdsProfile',\n'FirewallFloodProtectionProfile',\n'FirewallDnsProfile',\n'GeneralSecuritySettingsProfile'\n", 
      "required": true, 
      "title": "Resource type to use as profile type.", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseHostSwitchProfile (type) (Deprecated)

{
  "abstract": true, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BaseHostSwitchProfile", 
  "module_id": "BaseHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseInterfaceGroup (type)

{
  "additionalProperties": false, 
  "description": "Tier0/Tier1 Interface group for interface grouping.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseInterfaceGroup", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "members": {
      "description": "List of interface reference. Interface must belong to same location.", 
      "items": {
        "$ref": "GatewayInterfaceReference
      }, 
      "required": false, 
      "title": "Tier0/Tier1 interface memeber list", 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Base gateway Interface group", 
  "type": "object"
}

BaseListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BaseListRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

BaseNodeAggregateInfo (type)

{
  "additionalProperties": false, 
  "id": "BaseNodeAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "display_name": {
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node_interface_properties": {
      "items": {
        "$ref": "NodeInterfaceProperties
      }, 
      "readonly": true, 
      "title": "Array of Node interface statistic properties", 
      "type": "array"
    }, 
    "node_interface_statistics": {
      "items": {
        "$ref": "NodeInterfaceStatisticsProperties
      }, 
      "readonly": true, 
      "title": "Array of Node network interface statistic properties", 
      "type": "array"
    }, 
    "node_status": {
      "$ref": "ClusterNodeStatus, 
      "readonly": true
    }, 
    "node_status_properties": {
      "items": {
        "$ref": "NodeStatusProperties
      }, 
      "title": "Time series of the node's system properties", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BasePktCapResource (type)

{
  "abstract": true, 
  "id": "BasePktCapResource", 
  "module_id": "LiveTrace", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "required": true, 
      "title": "Type of packet capture resource", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BasePolicyServiceInstance (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an instance of partner Service and its configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BasePolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service in the Marketplace", 
      "required": true, 
      "title": "Name of Partner Service", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "default": "L2_BRIDGE", 
      "description": "Transport to be used while deploying Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Transport Type", 
      "type": "string"
    }, 
    "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": "Represents an instance of partner Service and its configuration", 
  "type": "object"
}

BaseRule (type)

{
  "additionalProperties": false, 
  "description": "A rule indicates the action to be performed for various types of traffic flowing between workload groups.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseRule", 
  "module_id": "Policy", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Rule", 
            "ForwardingRule", 
            "RedirectionRule"
          ], 
          "relationshipType": "COMMUNICATION_ENTRY_DEST_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "TlsRule"
          ], 
          "relationshipType": "TLS_GATEWAY_RULE_DEST_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "IdsRule"
          ], 
          "relationshipType": "IDS_RULE_DEST_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "SecurityPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "GatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "ForwardingPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "IdsGatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }
      ]
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs. Instead of Layer 7 service profiles you can use a L7 access profile. One of either Layer 7 service profiles or L7 Access Profile can be used in firewall rule. In case of L7 access profile only one is allowed.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles or TLS action profile", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Rule", 
            "ForwardingRule", 
            "RedirectionRule"
          ], 
          "relationshipType": "COMMUNICATION_ENTRY_CONTEXT_PROFILE_RELATIONSHIP", 
          "rightType": [
            "PolicyContextProfile"
          ]
        }, 
        {
          "leftType": [
            "TlsRule"
          ], 
          "relationshipType": "TLS_GATEWAY_RULE_CONTEXT_PROFILE_RELATIONSHIP", 
          "rightType": [
            "PolicyContextProfile"
          ]
        }, 
        {
          "leftType": [
            "IdsRule"
          ], 
          "relationshipType": "IDS_RULE_IDS_PROFILE_RELATIONSHIP", 
          "rightType": [
            "IdsProfile", 
            "IdsProfile"
          ]
        }, 
        {
          "leftType": [
            "SecurityPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "GatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "ForwardingPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "IdsGatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }
      ]
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Rule", 
            "ForwardingRule", 
            "RedirectionRule"
          ], 
          "relationshipType": "COMMUNICATION_ENTRY_SCOPE_RELATIONSHIP", 
          "rightType": [
            "PolicyLabel", 
            "Tier0Interface", 
            "Tier1Interface", 
            "Tier0", 
            "Tier1", 
            "IPSecVpnSession", 
            "Group"
          ]
        }, 
        {
          "leftType": [
            "TlsRule"
          ], 
          "relationshipType": "TLS_GATEWAY_RULE_SCOPE_RELATIONSHIP", 
          "rightType": [
            "PolicyLabel", 
            "Tier1Interface", 
            "Tier0", 
            "Tier1Interface", 
            "Tier1", 
            "Group"
          ]
        }, 
        {
          "leftType": [
            "IdsRule"
          ], 
          "relationshipType": "IDS_RULE_SCOPE_RELATIONSHIP", 
          "rightType": [
            "PolicyLabel", 
            "Tier1Interface", 
            "Tier0", 
            "Tier1Interface", 
            "Tier1", 
            "Group"
          ]
        }, 
        {
          "leftType": [
            "SecurityPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "GatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "ForwardingPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "IdsGatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }
      ]
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "In order to specify all services, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Rule", 
            "ForwardingRule", 
            "RedirectionRule"
          ], 
          "relationshipType": "COMMUNICATION_ENTRY_SERVICE_RELATIONSHIP", 
          "rightType": [
            "Service"
          ]
        }, 
        {
          "leftType": [
            "TlsRule"
          ], 
          "relationshipType": "TLS_GATEWAY_RULE_SERVICE_RELATIONSHIP", 
          "rightType": [
            "Service"
          ]
        }, 
        {
          "leftType": [
            "IdsRule"
          ], 
          "relationshipType": "IDS_RULE_SERVICE_RELATIONSHIP", 
          "rightType": [
            "Service"
          ]
        }, 
        {
          "leftType": [
            "SecurityPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "GatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "ForwardingPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "IdsGatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }
      ]
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Rule", 
            "ForwardingRule", 
            "RedirectionRule"
          ], 
          "relationshipType": "COMMUNICATION_ENTRY_SOURCE_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "TlsRule"
          ], 
          "relationshipType": "TLS_GATEWAY_RULE_SOURCE_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "IdsRule"
          ], 
          "relationshipType": "IDS_RULE_SOURCE_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }, 
        {
          "leftType": [
            "SecurityPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "GatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "ForwardingPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }, 
        {
          "leftType": [
            "IdsGatewayPolicy"
          ], 
          "relationshipType": "IGNORE", 
          "rightType": []
        }
      ]
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs. Even though there is no limitation on length of a tag, internally tag will get truncated after 32 characters.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "A rule represent base properties for ,dfw, forwarding, redirection rule", 
  "type": "object"
}

BaseRuleListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BaseRuleListResult", 
  "module_id": "Policy", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Rules", 
  "type": "object"
}

BaseServiceInstance (type)

{
  "abstract": true, 
  "description": "The deployment of a registered service. service instance is instantiation of service.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BaseServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "on_failure_policy": {
      "description": "Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED", 
        "NSH", 
        "NA"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Base Instance of a service", 
  "type": "object"
}

BaseServiceProfile (type)

{
  "description": "Base Service Profile", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BaseServiceProfile", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "Service Profile type, for example 'GiServiceProfile', 'ServiceInsertionServiceProfile'", 
      "required": true, 
      "title": "Service Profile Resource type.", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base Service Profile", 
  "type": "object"
}

BaseSwitchingProfile (type) (Deprecated)

{
  "abstract": true, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BaseSwitchingProfile", 
  "module_id": "BaseSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n'PortMirroringSwitchingProfile' is deprecated, please turn to\n\"Troubleshooting And Monitoring: Portmirroring\" and use\nPortMirroringSession API for port mirror function.\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseTier0Interface (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 interface configuration for external connectivity.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseTier0Interface", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_relay_path": {
      "description": "Policy path of dhcp-relay-config to be attached to this Interface.", 
      "required": false, 
      "title": "policy path of referenced dhcp-relay-config", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Tier0Interface", 
            "Tier1Interface"
          ], 
          "relationshipType": "DHCP_RELAY_CONFIG_RELATIONSHIP", 
          "rightType": [
            "DhcpRelayConfig"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subnets": {
      "description": "Specify IP address and network prefix for interface.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IP address and subnet specification for interface", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Tier-0 interface configuration", 
  "type": "object"
}

BasicAuthenticationScheme (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AuthenticationScheme
  }, 
  "id": "BasicAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "basic"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BatchParameter (type)

{
  "id": "BatchParameter", 
  "module_id": "Common", 
  "properties": {
    "atomic": {
      "default": false, 
      "description": "This flag is ignored. Transactional atomicity is no longer supported.", 
      "required": false, 
      "title": "Ignored (transactional atomicity flag)", 
      "type": "boolean"
    }
  }, 
  "title": "Options that affect how batch operations are processed", 
  "type": "object"
}

BatchRequest (type)

{
  "id": "BatchRequest", 
  "module_id": "Common", 
  "properties": {
    "continue_on_error": {
      "default": true, 
      "description": "Continue even if an error is encountered.", 
      "required": false, 
      "type": "boolean"
    }, 
    "requests": {
      "items": {
        "$ref": "BatchRequestItem
      }, 
      "sensitive": true, 
      "type": "array"
    }
  }, 
  "title": "A set of operations to be performed in a single batch", 
  "type": "object"
}

BatchRequestItem (type)

{
  "id": "BatchRequestItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "type": "object"
    }, 
    "method": {
      "description": "http method type", 
      "enum": [
        "GET", 
        "POST", 
        "PUT", 
        "DELETE", 
        "PATCH"
      ], 
      "required": true, 
      "title": "method type(POST/PUT/DELETE/UPDATE)", 
      "type": "string"
    }, 
    "uri": {
      "description": "relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters", 
      "required": true, 
      "title": "Internal uri of the call", 
      "type": "string"
    }
  }, 
  "title": "A single request within a batch of operations", 
  "type": "object"
}

BatchResponse (type)

{
  "additionalProperties": false, 
  "id": "BatchResponse", 
  "module_id": "Common", 
  "properties": {
    "has_errors": {
      "description": "Indicates if any of the APIs failed", 
      "title": "errors indicator", 
      "type": "boolean"
    }, 
    "results": {
      "items": {
        "$ref": "BatchResponseItem
      }, 
      "required": true, 
      "title": "Bulk list results", 
      "type": "array"
    }, 
    "rolled_back": {
      "description": "Optional flag indicating that all items were rolled back even if succeeded initially", 
      "title": "indicates if all items were rolled back.", 
      "type": "boolean"
    }
  }, 
  "title": "The reponse to a batch operation", 
  "type": "object"
}

BatchResponseItem (type)

{
  "id": "BatchResponseItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "description": "object returned by api", 
      "required": false, 
      "title": "object returned by api", 
      "type": "object"
    }, 
    "code": {
      "description": "http status code", 
      "required": true, 
      "title": "object returned by api", 
      "type": "integer"
    }, 
    "headers": {
      "description": "The headers returned by the API call", 
      "title": "object returned by api", 
      "type": "object"
    }
  }, 
  "title": "A single respose in a list of batched responses", 
  "type": "object"
}

BfdConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BfdConfig", 
  "module_id": "Routing", 
  "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"
    }, 
    "declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "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"
    }, 
    "enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable BFD for this LogicalRouter", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "receive_interval": {
      "default": 500, 
      "description": "the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.", 
      "maximum": 60000, 
      "minimum": 50, 
      "required": false, 
      "title": "Receive interval for heartbeats", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transmit_interval": {
      "default": 500, 
      "description": "the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.", 
      "maximum": 60000, 
      "minimum": 50, 
      "required": false, 
      "title": "Transmit interval for heartbeats", 
      "type": "integer"
    }
  }, 
  "title": "BFD configuration for LogicalRouter", 
  "type": "object"
}

BfdConfigParameters (type)

{
  "id": "BfdConfigParameters", 
  "module_id": "Routing", 
  "properties": {
    "declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "receive_interval": {
      "default": 500, 
      "description": "The time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.| For edge cluster type of bare metal, this value should be >= 50ms.| For edge cluster type of virtual machine or hybrid, this value should be >= 500ms.", 
      "maximum": 60000, 
      "minimum": 50, 
      "required": false, 
      "title": "Receive interval for heartbeats", 
      "type": "integer"
    }, 
    "transmit_interval": {
      "default": 500, 
      "description": "The time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.| For edge cluster type of bare metal, this value should be >= 300ms.| For edge cluster type of virtual machine or hybrid, this value should be >= 1000ms.", 
      "maximum": 60000, 
      "minimum": 50, 
      "required": false, 
      "title": "Transmit interval for heartbeats", 
      "type": "integer"
    }
  }, 
  "title": "BFD configuration for the given Peer.", 
  "type": "object"
}

BfdHealthMonitoringConfig (type)

{
  "description": "Bfd Health Monitoring Options used specific to BFD Transport Zone profiles", 
  "id": "BfdHealthMonitoringConfig", 
  "module_id": "PolicyTransportZoneProfile", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "Whether the heartbeat is enabled. A PATCH or PUT request with \"enabled\" false (with no probe intervals) will set or reset the probe_interval to their default value.", 
      "type": "boolean"
    }, 
    "latency_enabled": {
      "description": "The flag is to turn on/off latency. A PATCH or PUT request with \"latency_enabled\" true will enable NSX to send the networking latency data to thrid-party monitoring tools like vRNI.", 
      "required": false, 
      "title": "Whether the latency is enabled.", 
      "type": "boolean"
    }, 
    "probe_interval": {
      "default": 1000, 
      "minimum": 300, 
      "required": false, 
      "title": "The time interval (in millisec) between probe packets for tunnels between transport nodes.", 
      "type": "integer"
    }
  }, 
  "title": "Bfd Health Monitoring Options", 
  "type": "object"
}

BfdHealthMonitoringProfile (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "TransportZoneProfile
  }, 
  "id": "BfdHealthMonitoringProfile", 
  "module_id": "BfdHealthMonitoringProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BfdHealthMonitoringProfile"
  }, 
  "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"
    }, 
    "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"
    }, 
    "enabled": {
      "required": true, 
      "title": "Whether the heartbeat is enabled. A POST or PUT request with \"enabled\" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "latency_enabled": {
      "description": "The flag is to turn on/off latency. A POST or PUT request with \"latency_enabled\" true will enable NSX to send the networking latency data to thrid-party monitoring tools like vRNI.", 
      "required": false, 
      "title": "Whether the latency is enabled.", 
      "type": "boolean"
    }, 
    "probe_interval": {
      "default": 1000, 
      "minimum": 300, 
      "required": false, 
      "title": "The time interval (in millisec) between probe packets for tunnels between transport nodes.", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "BfdHealthMonitoringProfile"
      ], 
      "help_summary": "Possible value is 'BfdHealthMonitoringProfile'", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD health monitoring", 
  "type": "object"
}

BfdProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BfdProfile", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "interval": {
      "default": 500, 
      "description": "Time interval between heartbeat packets in milliseconds.", 
      "maximum": 60000, 
      "minimum": 50, 
      "title": "Time interval between heartbeat packets in milliseconds", 
      "type": "int"
    }, 
    "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"
    }, 
    "multiple": {
      "default": 3, 
      "description": "Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.", 
      "maximum": 16, 
      "minimum": 2, 
      "title": "Declare dead multiple", 
      "type": "int"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Bidirectional Forwarding Detection configuration for BGP peers", 
  "type": "object"
}

BfdProfileListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of BfdProfile.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BfdProfileListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Bfd Profile list results.", 
      "items": {
        "$ref": "BfdProfile
      }, 
      "required": true, 
      "title": "Bfd Profile List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of BfdProfile", 
  "type": "object"
}

BgpAddressFamily (type)

{
  "additionalProperties": false, 
  "id": "BgpAddressFamily", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "in_prefix_count": {
      "description": "Count of in prefixes", 
      "readonly": true, 
      "required": false, 
      "title": "Count of in prefixes", 
      "type": "integer"
    }, 
    "out_prefix_count": {
      "description": "Count of out prefixes", 
      "readonly": true, 
      "required": false, 
      "title": "Count of out prefixes", 
      "type": "integer"
    }, 
    "type": {
      "description": "BGP address family type", 
      "enum": [
        "IPV4_UNICAST", 
        "VPNV4_UNICAST", 
        "IPV6_UNICAST", 
        "L2VPN_EVPN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "BGP address family type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpBfdConfig (type)

{
  "additionalProperties": false, 
  "id": "BgpBfdConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enabled": {
      "default": false, 
      "description": "Flag to enable BFD cofiguration.", 
      "title": "Flag to enable BFD cofiguration", 
      "type": "boolean"
    }, 
    "interval": {
      "default": 500, 
      "description": "Time interval between heartbeat packets in milliseconds.", 
      "maximum": 60000, 
      "minimum": 50, 
      "title": "Time interval between heartbeat packets in milliseconds", 
      "type": "int"
    }, 
    "multiple": {
      "default": 3, 
      "description": "Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.", 
      "maximum": 16, 
      "minimum": 2, 
      "title": "Declare dead multiple", 
      "type": "int"
    }
  }, 
  "title": "BFD configuration for BGP peers", 
  "type": "object"
}

BgpConfig (type)

{
  "additionalProperties": false, 
  "description": "BGP configuration for Tier0 logical router. We create BGP configuration while creation of Tier0 logical router.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BgpConfig", 
  "module_id": "Routing", 
  "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"
    }, 
    "as_num": {
      "description": "For VRF logical router, the as_num from parent logical router will be effective.", 
      "required": false, 
      "title": "4 Byte ASN in ASPLAIN/ASDOT Format", 
      "type": "string"
    }, 
    "as_number": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'as_num' instead. For VRF logical router, the as_number from parent logical router will be effective.", 
      "maximum": 4294967296, 
      "minimum": 1, 
      "required": false, 
      "title": "Autonomous System Number", 
      "type": "integer"
    }, 
    "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"
    }, 
    "ecmp": {
      "default": true, 
      "description": "While creation of BGP config this flag will be set to true User can change this value while updating BGP config. If this property is not specified in the payload, the default value will be considered as true.", 
      "required": false, 
      "title": "Flag to enable outbound ECMP", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": false, 
      "description": "While creation of BGP config this flag will be set to - true for Tier0 logical router with Active-Active high-availability mode - false for Tier0 logical router with Active-Standby high-availanility mode. User can change this value while updating the config. If this property is not specified in the payload, the default value will be considered as false irrespective of the high-availability mode.", 
      "required": false, 
      "title": "Flag to enable this configuration", 
      "type": "boolean"
    }, 
    "graceful_restart": {
      "deprecated": true, 
      "description": "Flag to enable graceful restart. This field is deprecated, kindly use graceful_restart_config parameter for graceful restart configuration. If both parameters are set and consistent with each other [i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR graceful_restart=true and graceful_restart_mode=GR_AND_HELPER] then this is allowed, but if inconsistent with each other then this is not allowed and validation error will be thrown. For VRF logical router, the settings from parent logical router will be effective.", 
      "required": false, 
      "title": "Flag to enable graceful restart", 
      "type": "boolean"
    }, 
    "graceful_restart_config": {
      "$ref": "GracefulRestartConfig, 
      "description": "Configuration parameters for BGP Graceful Restart functionality. It has graceful_restart_mode and graceful_restart_timer parameters. For VRF logical router, the settings from parent logical router will be effective.", 
      "required": false, 
      "title": "BGP Graceful Restart configuration"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "inter_sr_ibgp": {
      "$ref": "InterSRRoutingConfig, 
      "required": false, 
      "title": "Inter SR IBGP configuration"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "multipath_relax": {
      "description": "For TIER0 logical router, default is true. For VRF logical router, the settings from parent logical router will be effective.", 
      "required": false, 
      "title": "Flag to enable BGP multipath relax option.", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "route_aggregation": {
      "items": {
        "$ref": "BgpRouteAggregation
      }, 
      "maxItems": 1000, 
      "minItems": 0, 
      "required": false, 
      "title": "List of routes to be aggregated", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "BGP configuration for logical router", 
  "type": "object"
}

BgpGracefulRestartConfig (type)

{
  "additionalProperties": false, 
  "description": "Configuration field to hold BGP restart mode and timer.", 
  "id": "BgpGracefulRestartConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "mode": {
      "default": "HELPER_ONLY", 
      "description": "If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.", 
      "enum": [
        "DISABLE", 
        "GR_AND_HELPER", 
        "HELPER_ONLY"
      ], 
      "required": false, 
      "title": "BGP Graceful Restart Configuration Mode", 
      "type": "string"
    }, 
    "timer": {
      "$ref": "BgpGracefulRestartTimer, 
      "description": "Configuration field to hold BGP restart timers.", 
      "title": "BGP Graceful Restart Timer"
    }
  }, 
  "title": "BGP Graceful Restart Configuration", 
  "type": "object"
}

BgpGracefulRestartTimer (type)

{
  "additionalProperties": false, 
  "description": "Configuration field to hold BGP restart timers", 
  "id": "BgpGracefulRestartTimer", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "restart_timer": {
      "default": 180, 
      "description": "Maximum time taken (in seconds) for a BGP session to be established after a restart. This can be used to speed up routing convergence by its peer in case the BGP speaker does not come back up after a restart. If the session is not re-established within this timer,  the receiving speaker will delete all the stale routes from that peer.", 
      "maximum": 3600, 
      "minimum": 1, 
      "title": "BGP Graceful Restart Timer", 
      "type": "integer"
    }, 
    "stale_route_timer": {
      "default": 600, 
      "description": "Maximum time (in seconds) before stale routes are removed from the RIB (Routing Information Base) when BGP restarts.", 
      "maximum": 3600, 
      "minimum": 1, 
      "title": "BGP Stale Route Timer", 
      "type": "integer"
    }
  }, 
  "title": "BGP Graceful Restart Timers", 
  "type": "object"
}

BgpNeighbor (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BgpNeighbor", 
  "module_id": "Routing", 
  "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"
    }, 
    "address_families": {
      "description": "User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.", 
      "items": {
        "$ref": "BgpNeighborAddressFamily
      }, 
      "required": false, 
      "title": "AddressFamily settings for the neighbor", 
      "type": "array"
    }, 
    "allow_as_in": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable allowas_in option for BGP neighbor", 
      "type": "boolean"
    }, 
    "bfd_config": {
      "$ref": "BfdConfigParameters, 
      "description": "By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer)", 
      "required": false, 
      "title": "BFD Configuration Parameters for the given peer."
    }, 
    "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"
    }, 
    "enable_bfd": {
      "default": false, 
      "description": "Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.", 
      "required": false, 
      "title": "Enable BFD for this BGP Neighbor", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable this BGP Neighbor", 
      "type": "boolean"
    }, 
    "filter_in_ipprefixlist_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please  use 'address_family' instead.", 
      "required": false, 
      "title": "IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_in_routemap_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "RouteMap to be used for IN direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_out_ipprefixlist_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_out_routemap_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "RouteMap to be used for OUT direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "graceful_restart_mode": {
      "$ref": "GracefulRestartMode, 
      "description": "BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.", 
      "required": false, 
      "title": "Graceful Restart Mode"
    }, 
    "hold_down_timer": {
      "default": 180, 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Wait period (seconds) before declaring peer dead", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "keep_alive_timer": {
      "default": 60, 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Frequency (seconds) with which keep alive messages are sent to peers", 
      "type": "integer"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "maximum_hop_limit": {
      "default": 1, 
      "description": "This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then  next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0.", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum Number of hops allowed to reach BGP neighbor", 
      "type": "int"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "Neighbor IP Address"
    }, 
    "password": {
      "description": "User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 32 characters.", 
      "maxLength": 32, 
      "minLength": 1, 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "remote_as": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'remote_as_num' instead.", 
      "maximum": 4294967296, 
      "minimum": 1, 
      "required": false, 
      "title": "Autonomous System Number of the neighbor", 
      "type": "integer"
    }, 
    "remote_as_num": {
      "required": false, 
      "title": "4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "deprecated": true, 
      "description": "Deprecated - do not provide a value for this field. Use source_addresses instead.", 
      "required": false, 
      "title": "Logical Router Uplink IP Address"
    }, 
    "source_addresses": {
      "description": "BGP neighborship will be formed from all these source addresses to this neighbour.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "Array of Logical Router Uplink IP Addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BgpNeighborAddressFamily (type)

{
  "id": "BgpNeighborAddressFamily", 
  "module_id": "Routing", 
  "properties": {
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Enable this address family", 
      "type": "boolean"
    }, 
    "in_filter_ipprefixlist_id": {
      "required": false, 
      "title": "Id of the IPPrefix List to be used for IN direction filter", 
      "type": "string"
    }, 
    "in_filter_routemap_id": {
      "required": false, 
      "title": "Id of the RouteMap to be used for IN direction filter", 
      "type": "string"
    }, 
    "maximum_routes": {
      "minimum": 0, 
      "required": false, 
      "title": "Maximum number of routes supported on the address family", 
      "type": "integer"
    }, 
    "out_filter_ipprefixlist_id": {
      "required": false, 
      "title": "Id of the IPPrefixList to be used for OUT direction filter", 
      "type": "string"
    }, 
    "out_filter_routemap_id": {
      "required": false, 
      "title": "Id of the RouteMap to be used for OUT direction filter", 
      "type": "string"
    }, 
    "type": {
      "$ref": "AddressFamilyType, 
      "required": true, 
      "title": "Address family type"
    }
  }, 
  "type": "object"
}

BgpNeighborConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains information necessary to configure a BGP neighbor.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BgpNeighborConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "allow_as_in": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable allowas_in option for BGP neighbor", 
      "type": "boolean"
    }, 
    "bfd": {
      "$ref": "BgpBfdConfig, 
      "description": "BFD configuration for failure detection. BFD is enabled with default values when not configured.", 
      "title": "BFD configuration for failure detection"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable/disable BGP peering. Disabling will stop the BGP peering. True - indicates enable BGP peering, False - indicates disable BGP peering. Default is True.", 
      "required": false, 
      "title": "Flag to enable/disable BGP peering.", 
      "type": "boolean"
    }, 
    "graceful_restart_mode": {
      "description": "If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.", 
      "enum": [
        "DISABLE", 
        "GR_AND_HELPER", 
        "HELPER_ONLY"
      ], 
      "title": "BGP Graceful Restart Configuration Mode", 
      "type": "string"
    }, 
    "hold_down_time": {
      "default": 180, 
      "description": "Wait time in seconds before declaring peer dead.", 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Wait time in seconds before declaring peer dead", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "in_route_filters": {
      "deprecated": true, 
      "description": "Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for IN direction", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_PREFIX_LIST_RELATIONSHIP", 
          "rightType": [
            "PrefixList"
          ]
        }, 
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_ROUTE_MAP_RELATIONSHIP", 
          "rightType": [
            "Tier0RouteMap"
          ]
        }
      ]
    }, 
    "keep_alive_time": {
      "default": 60, 
      "description": "Interval (in seconds) between keep alive messages sent to peer.", 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Interval between keep alive messages sent to peer", 
      "type": "int"
    }, 
    "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"
    }, 
    "maximum_hop_limit": {
      "default": 1, 
      "description": "Maximum number of hops allowed to reach BGP neighbor.", 
      "maximum": 255, 
      "minimum": 1, 
      "title": "Maximum number of hops allowed to reach BGP neighbor", 
      "type": "int"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "Neighbor IP Address"
    }, 
    "neighbor_local_as_config": {
      "$ref": "BgpNeighborLocalAsConfig, 
      "description": "Configuration field to hold the Local AS config for BGP Neighbor", 
      "required": false, 
      "title": "Local as configuration for BGP Neighbor"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "type": "string"
    }, 
    "out_route_filters": {
      "deprecated": true, 
      "description": "Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for OUT direction", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_PREFIX_LIST_RELATIONSHIP", 
          "rightType": [
            "PrefixList"
          ]
        }, 
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_ROUTE_MAP_RELATIONSHIP", 
          "rightType": [
            "Tier0RouteMap"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "password": {
      "description": "Specify password for BGP neighbor authentication. Empty string (\"\") clears existing password.", 
      "maxLength": 32, 
      "minLength": 0, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "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"
    }, 
    "remote_as_num": {
      "required": true, 
      "title": "4 Byte ASN of the neighbor in ASPLAIN Format", 
      "type": "string"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "route_filtering": {
      "description": "Enable address families and route filtering in each direction.", 
      "items": {
        "$ref": "BgpRouteFiltering
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "Enable address families and route filtering in each direction", 
      "type": "array"
    }, 
    "source_addresses": {
      "description": "Source addresses should belong to Tier0 external or loopback or VTI interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "Source IP Addresses for BGP peering", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_SOURCE_ADDRESS_TIER0_INTERFACE_RELATIONSHIP", 
          "rightType": [
            "Tier0Interface"
          ]
        }
      ]
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "BGP neighbor config", 
  "type": "object"
}

BgpNeighborConfigListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "BgpNeighborConfigListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routing Config list request parameters", 
  "type": "object"
}

BgpNeighborConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighborConfig
      }, 
      "required": true, 
      "title": "BGP neighbor configs list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of BGP Neighbor Configs", 
  "type": "object"
}

BgpNeighborListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborListResult", 
  "module_id": "Routing", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighbor
      }, 
      "required": true, 
      "title": "Paginated list of bgp neighbors", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpNeighborLocalAsConfig (type)

{
  "additionalProperties": false, 
  "id": "BgpNeighborLocalAsConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "as_path_modifier_type": {
      "description": "Optional parameter.  If this property is not set, by default BGP prepends neighbor's local_as_num value to the AS_PATH for BOTH outgoing and incoming route advertisements from the peer neighbor. By setting one of the following value, user can modify the default prepend action on the AS_PATH in both inbound and outbound direction. NO_PREPEND: If type is NO_PREPEND, then the local router will NOT prepend the incoming advertisement from that             peer with neighbor's local_as_num, so the AS path advertised will now prepend only the BGP             local-as of the router. NO_PREPEND_REPLACE_AS - If type is \"NO_PREPEND_REPLACE_AS\", then  the local routes will be advertised with             the neighbor's local-as instead of the BGP's local-as to peer router.", 
      "enum": [
        "NO_PREPEND", 
        "NO_PREPEND_REPLACE_AS"
      ], 
      "required": false, 
      "title": "AS_PATH modifier type for BGP local AS", 
      "type": "string"
    }, 
    "local_as_num": {
      "description": "Specify local-as number for Tier-0 to advertize to BGP peer. This overrides local_as_num configured in the BgpRoutingConfig object. AS number can be specified in ASPLAIN (e.g., \"65546\") or ASDOT (e.g., \"1.10\") format. It is supported for BgpNeighborConfig under both default tier0 and vrf tier0. When this capability is configured, it enables the BGP to prepend \"local_as_num\" value to the beginning of AS_PATH for BOTH outgoing  and incoming route advertisements from the configured neighbor. After prepend, AS_PATH contains both \"neighbor's <local_as_num>\" and BGP's <local_as_num>.", 
      "required": true, 
      "title": "BGP neighbor local-as number in ASPLAIN/ASDOT Format", 
      "type": "string"
    }
  }, 
  "title": "BGP neighbor local-as configuration", 
  "type": "object"
}

BgpNeighborRouteDetails (type)

{
  "additionalProperties": false, 
  "description": "BGP neighbor learned/advertised route details.", 
  "id": "BgpNeighborRouteDetails", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "logical_router_id": {
      "readonly": true, 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor peer IP address.", 
      "readonly": true, 
      "required": true, 
      "title": "Neighbor IP address"
    }, 
    "neighbor_id": {
      "readonly": true, 
      "required": true, 
      "title": "BGP neighbor id", 
      "type": "string"
    }, 
    "per_transport_node_routes": {
      "description": "Array of BGP neighbor route details per transport node.", 
      "items": {
        "$ref": "RoutesPerTransportNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Route details per transport node", 
      "type": "array"
    }
  }, 
  "title": "BGP neighbor route details", 
  "type": "object"
}

BgpNeighborRouteDetailsCsvRecord (type)

{
  "additionalProperties": false, 
  "description": "BGP neighbor learned/advertised route details.", 
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "BgpNeighborRouteDetailsCsvRecord", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "as_path": {
      "description": "BGP AS path attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "AS path", 
      "type": "string"
    }, 
    "local_pref": {
      "description": "BGP Local Preference attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Local preference", 
      "type": "integer"
    }, 
    "logical_router_id": {
      "description": "Logical router id", 
      "readonly": true, 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "med": {
      "description": "BGP Multi Exit Discriminator attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Multi Exit Discriminator", 
      "type": "integer"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor peer IP address.", 
      "readonly": true, 
      "required": true, 
      "title": "Neighbor IP address"
    }, 
    "neighbor_id": {
      "description": "BGP neighbor id", 
      "readonly": true, 
      "required": true, 
      "title": "BGP neighbor id", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPCIDRBlock, 
      "description": "CIDR network address.", 
      "readonly": true, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "Next hop IP address.", 
      "readonly": true, 
      "required": false, 
      "title": "Next hop IP address"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor source address.", 
      "readonly": true, 
      "required": false, 
      "title": "BGP neighbor source address"
    }, 
    "transport_node_id": {
      "description": "Transport node id", 
      "readonly": true, 
      "required": true, 
      "title": "Transport node id", 
      "type": "string"
    }, 
    "weight": {
      "description": "BGP Weight attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Weight", 
      "type": "integer"
    }
  }, 
  "title": "BGP neighbor route details", 
  "type": "object"
}

BgpNeighborRouteDetailsInCsvFormat (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "BgpNeighborRouteDetailsInCsvFormat", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighborRouteDetailsCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

BgpNeighborRoutes (type)

{
  "additionalProperties": false, 
  "description": "BGP neighbor learned/advertised route details.", 
  "id": "BgpNeighborRoutes", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_node_routes": {
      "description": "Array of BGP neighbor route details per edge node.", 
      "items": {
        "$ref": "RoutesPerTransportNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Route details per transport node", 
      "type": "array"
    }, 
    "egde_node_routes": {
      "deprecated": true, 
      "description": "Array of BGP neighbor route details per edge node.", 
      "items": {
        "$ref": "RoutesPerTransportNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Route details per transport node", 
      "type": "array"
    }, 
    "enforcement_point_path": {
      "readonly": true, 
      "required": true, 
      "title": "Enforcement point policy path", 
      "type": "string"
    }, 
    "neighbor_path": {
      "readonly": true, 
      "required": true, 
      "title": "BGP neighbor policy path", 
      "type": "string"
    }
  }, 
  "title": "BGP neighbor route details", 
  "type": "object"
}

BgpNeighborRoutesListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborRoutesListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paged Collection of Bgp neighbor routes.", 
      "items": {
        "$ref": "BgpNeighborRoutes
      }, 
      "required": false, 
      "title": "Paged Collection of Bgp neighbor routes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpNeighborStatus (type)

{
  "additionalProperties": false, 
  "id": "BgpNeighborStatus", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "address_families": {
      "description": "Address families of BGP neighbor", 
      "items": {
        "$ref": "BgpAddressFamily
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Address families of BGP neighbor", 
      "type": "array"
    }, 
    "announced_capabilities": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities sent to BGP neighbor.", 
      "type": "array"
    }, 
    "connection_drop_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connection drop", 
      "type": "integer"
    }, 
    "connection_state": {
      "enum": [
        "INVALID", 
        "IDLE", 
        "CONNECT", 
        "ACTIVE", 
        "OPEN_SENT", 
        "OPEN_CONFIRM", 
        "ESTABLISHED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Current state of the BGP session.", 
      "type": "string"
    }, 
    "established_connection_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connections established", 
      "type": "integer"
    }, 
    "graceful_restart": {
      "deprecated": true, 
      "description": "Current state of graceful restart where graceful_restart = true indicates graceful restart is enabled and graceful_restart = false indicates graceful restart is disabled. This is deprecated field, use graceful_restart_mode instead.", 
      "readonly": true, 
      "required": false, 
      "title": "Graceful restart flag", 
      "type": "boolean"
    }, 
    "graceful_restart_mode": {
      "description": "Current state of graceful restart of BGP neighbor. Possible values are - 1. GR_AND_HELPER - Graceful restart with Helper 2. HELPER_ONLY - Helper only 3. DISABLE - Disabled", 
      "readonly": true, 
      "required": false, 
      "title": "Graceful restart mode", 
      "type": "string"
    }, 
    "hold_time": {
      "readonly": true, 
      "required": false, 
      "title": "Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.", 
      "type": "integer"
    }, 
    "keep_alive_interval": {
      "readonly": true, 
      "required": false, 
      "title": "Time in ms to wait for HELLO packet from BGP peer", 
      "type": "integer"
    }, 
    "local_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of Local BGP connection", 
      "type": "integer"
    }, 
    "lr_component_id": {
      "readonly": true, 
      "required": true, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "messages_received": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages received from the neighbor", 
      "type": "integer"
    }, 
    "messages_sent": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages sent to the neighbor", 
      "type": "integer"
    }, 
    "negotiated_capability": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities negotiated with BGP neighbor.", 
      "type": "array"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "required": false, 
      "title": "The IP of the BGP neighbor"
    }, 
    "neighbor_router_id": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "required": false, 
      "title": "Router ID of the BGP neighbor."
    }, 
    "remote_as_number": {
      "readonly": true, 
      "required": false, 
      "title": "AS number of the BGP neighbor", 
      "type": "string"
    }, 
    "remote_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of remote BGP Connection", 
      "type": "integer"
    }, 
    "remote_site": {
      "$ref": "ResourceReference, 
      "description": "Remote site details.", 
      "readonly": true, 
      "title": "Remote site"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "required": false, 
      "title": "The Ip address of logical port"
    }, 
    "time_since_established": {
      "readonly": true, 
      "required": false, 
      "title": "Time(in seconds) since connection was established.", 
      "type": "integer"
    }, 
    "total_in_prefix_count": {
      "description": "Sum of in prefixes counts across all address families.", 
      "readonly": true, 
      "required": false, 
      "title": "Count of in prefixes", 
      "type": "integer"
    }, 
    "total_out_prefix_count": {
      "description": "Sum of out prefixes counts across all address families.", 
      "readonly": true, 
      "required": false, 
      "title": "Count of out prefixes", 
      "type": "integer"
    }, 
    "transport_node": {
      "$ref": "ResourceReference, 
      "readonly": true, 
      "required": false, 
      "title": "Transport node id and name"
    }, 
    "type": {
      "description": "BGP neighbor type", 
      "enum": [
        "INTER_SR", 
        "USER"
      ], 
      "readonly": true, 
      "title": "BGP neighbor type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpNeighborStatusLiteDto (type)

{
  "additionalProperties": false, 
  "id": "BgpNeighborStatusLiteDto", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "connection_state": {
      "description": "Current state of the BGP session.", 
      "enum": [
        "INVALID", 
        "IDLE", 
        "CONNECT", 
        "ACTIVE", 
        "OPEN_SENT", 
        "OPEN_CONFIRM", 
        "ESTABLISHED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "BGP session state", 
      "type": "string"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "description": "Ip address of BGP neighbor.", 
      "readonly": true, 
      "title": "Neighor address"
    }, 
    "remote_site": {
      "$ref": "ResourceReference, 
      "description": "Remote site details.", 
      "readonly": true, 
      "title": "Remote site"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "description": "Source Ip address.", 
      "readonly": true, 
      "title": "Source address"
    }
  }, 
  "type": "object"
}

BgpNeighborsStatusListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborsStatusListResult", 
  "module_id": "AggSvcLogicalRouter", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated, unset if data source has never updated the data.", 
      "readonly": true, 
      "title": "Timestamp indicating last update time of data"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "logical_router_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the logical router", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "additionalProperties": false, 
      "items": {
        "$ref": "BgpNeighborStatus
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Status of BGP neighbors of the logical router", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpRouteAggregation (type)

{
  "additionalProperties": false, 
  "id": "BgpRouteAggregation", 
  "module_id": "Routing", 
  "properties": {
    "prefix": {
      "$ref": "IPCIDRBlock, 
      "required": true, 
      "title": "cidr of the aggregate address"
    }, 
    "summary_only": {
      "default": true, 
      "required": false, 
      "title": "Flag to send only summarized route", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

BgpRouteFiltering (type)

{
  "additionalProperties": false, 
  "id": "BgpRouteFiltering", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "address_family": {
      "description": "Address family type. If not configured, this property automatically derived for IPv4 & IPv6 peer configuration.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "L2VPN_EVPN"
      ], 
      "title": "Address family type", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable address family.", 
      "title": "Enable address family", 
      "type": "boolean"
    }, 
    "in_route_filters": {
      "description": "Specify path of prefix-list or route map to filter routes for IN direction.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for IN direction", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_PREFIX_LIST_RELATIONSHIP", 
          "rightType": [
            "PrefixList"
          ]
        }, 
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_ROUTE_MAP_RELATIONSHIP", 
          "rightType": [
            "Tier0RouteMap"
          ]
        }
      ]
    }, 
    "maximum_routes": {
      "description": "Maximum number of routes for the address family.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum number of routes for the address family", 
      "type": "int"
    }, 
    "out_route_filters": {
      "description": "Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for OUT direction", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_PREFIX_LIST_RELATIONSHIP", 
          "rightType": [
            "PrefixList"
          ]
        }, 
        {
          "leftType": [
            "BgpNeighborConfig"
          ], 
          "relationshipType": "BGP_NEIGHBOR_ROUTE_MAP_RELATIONSHIP", 
          "rightType": [
            "Tier0RouteMap"
          ]
        }
      ]
    }
  }, 
  "title": "Enable address_families and route filtering in each direction", 
  "type": "object"
}

BgpRouteLeaking (type)

{
  "additionalProperties": false, 
  "id": "BgpRouteLeaking", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "address_family": {
      "description": "Address family type. Assumed IPv4 address family when not specified.", 
      "enum": [
        "IPV4", 
        "IPV6"
      ], 
      "title": "Address family type", 
      "type": "string"
    }, 
    "in_filter": {
      "description": "Specify path of route map to filter routes for IN direction. If not specified then all exported routes from peer attachment will be imported.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "route map path for IN direction", 
      "type": "array"
    }, 
    "out_filter": {
      "description": "Specify path of route map to filter routes for OUT direction. If not specified then all redistribute routes will be exported.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "route map path for OUT direction", 
      "type": "array"
    }
  }, 
  "title": "BGP route leaking in each direction", 
  "type": "object"
}

BgpRoutesRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "BgpRoutesRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "count": {
      "default": 1000, 
      "description": "Number of routes to return in response. Not used when routes are requested in CSV format.", 
      "minimum": 1, 
      "title": "Number of routes to retrieve", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "BGP Routes request parameters", 
  "type": "object"
}

BgpRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains BGP routing configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BgpRoutingConfig", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildBgpNeighborConfig"
  ], 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "ebgp_admin_distance": {
      "default": 20, 
      "description": "Administrative distance for IPv4 and IPv6 eBGP learnt routes(inbound). User is allowed to set this value only if BGP is disabled.", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "eBGP route administrative distance", 
      "type": "int"
    }, 
    "ecmp": {
      "description": "Flag to enable ECMP.", 
      "required": false, 
      "title": "Flag to enable ECMP", 
      "type": "boolean"
    }, 
    "enabled": {
      "description": "Flag to enable BGP configuration. Disabling will stop feature and BGP peering.", 
      "required": false, 
      "title": "Flag to enable BGP configuration", 
      "type": "boolean"
    }, 
    "graceful_restart": {
      "deprecated": true, 
      "description": "Flag to enable graceful restart. This field is deprecated, please use graceful_restart_config parameter for graceful restart configuration. If both parameters are set and consistent with each other (i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR graceful_restart=true and graceful_restart_mode=GR_AND_HELPER) then this is allowed, but if inconsistent with each other then this is not allowed and validation error will be thrown.", 
      "required": false, 
      "title": "Flag to enable graceful restart", 
      "type": "boolean"
    }, 
    "graceful_restart_config": {
      "$ref": "BgpGracefulRestartConfig, 
      "description": "Configuration field to hold BGP Restart mode and timer.", 
      "title": "BGP Graceful Restart Configuration"
    }, 
    "ibgp_admin_distance": {
      "default": 200, 
      "description": "Administrative distance for IPv4 and IPv6 iBGP learnt routes(inbound). User is allowed to set this value only if BGP is disabled.", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "iBGP route administrative distance", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "inter_sr_ibgp": {
      "description": "Flag to enable inter SR IBGP configuration. When not specified, inter SR IBGP is automatically enabled if Tier-0 is created in ACTIVE_ACTIVE ha_mode.", 
      "required": false, 
      "title": "Enable inter SR IBGP configuration", 
      "type": "boolean"
    }, 
    "local_as_num": {
      "description": "Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., \"65546\") or ASDOT (e.g., \"1.10\") format. Empty string disables BGP feature. It is required by normal tier0 but not required in vrf tier0.", 
      "required": false, 
      "title": "BGP AS number in ASPLAIN/ASDOT Format", 
      "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"
    }, 
    "multipath_relax": {
      "description": "Flag to enable BGP multipath relax option.", 
      "required": false, 
      "title": "Flag to enable BGP multipath relax option", 
      "type": "boolean"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "route_aggregations": {
      "description": "List of routes to be aggregated.", 
      "items": {
        "$ref": "RouteAggregationEntry
      }, 
      "maxItems": 1000, 
      "required": false, 
      "title": "List of routes to be aggregated", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "BGP routing config", 
  "type": "object"
}

BinaryPacketData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PacketData
  }, 
  "id": "BinaryPacketData", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BinaryPacketData"
  }, 
  "properties": {
    "frame_size": {
      "default": 128, 
      "description": "If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.  The frame will be zero padded to the requested size.", 
      "maximum": 1000, 
      "minimum": 60, 
      "required": false, 
      "title": "Requested total size of the (logical) packet in bytes", 
      "type": "integer"
    }, 
    "payload": {
      "description": "Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload must contain all headers (Ethernet, IP, etc). Note that VLAN is not supported in the logical space. Hence, payload must not contain 802.1Q headers.", 
      "maxLength": 1336, 
      "required": false, 
      "title": "RFC3548 compatible base64 encoded full payload", 
      "type": "string"
    }, 
    "resource_type": {
      "default": "FieldsPacketData", 
      "enum": [
        "BinaryPacketData", 
        "FieldsPacketData"
      ], 
      "required": true, 
      "title": "Packet configuration", 
      "type": "string"
    }, 
    "routed": {
      "description": "When this flag is set, traceflow packet will have its destination overwritten as the gateway address of the logical router to which the source logical switch is connected. More specifically: - For ARP request, the target IP will be overwritten as gateway IP if the target   IP is not in the same subnet of gateway. - For ARP response, the target IP and destination MAC will be overwritten as   gateway IP/MAC respectively, if the target IP is not in the same subnet of gateway. - For IP packet, the destination MAC will be overwritten as gateway MAC.", 
      "required": false, 
      "title": "Awareness of logical routing", 
      "type": "boolean"
    }, 
    "transport_type": {
      "default": "UNICAST", 
      "description": "This type takes effect only for IP packet.", 
      "enum": [
        "BROADCAST", 
        "UNICAST", 
        "MULTICAST", 
        "UNKNOWN"
      ], 
      "required": false, 
      "title": "Transport type of the traceflow packet", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BingdingMapStackStatusListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters for port/group/segment binding map mirror stack status.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BingdingMapStackStatusListRequestParameters", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String path for the enforcement point.", 
      "required": false, 
      "title": "Binding map path enforcemnt point path to remote L3 mirror session", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Request parameters for binding map mirror stack status", 
  "type": "object"
}

BlackholeAction (type)

{
  "additionalProperties": false, 
  "enum": [
    "DISCARD"
  ], 
  "id": "BlackholeAction", 
  "module_id": "Routing", 
  "title": "Action to be taken on matching packets for NULL routes. For action is DISCARD, matching packets are dropped rather than forwarded.", 
  "type": "string"
}

BpduFilter (type) (Deprecated)

{
  "deprecated": true, 
  "id": "BpduFilter", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "properties": {
    "enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether BPDU filter is enabled", 
      "type": "boolean"
    }, 
    "white_list": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 32, 
      "minItems": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering", 
      "type": "array"
    }
  }, 
  "title": "BPDU filter configuration", 
  "type": "object"
}

BridgeEndpoint (type)

{
  "description": "A bridge endpoint can be created on a bridge cluster or on an edge cluster. Few of the properties of this class will not be used depending on the type of bridge endpoint being created. When creating a bridge endpoint on a bridge cluster, following propeties will be used: vlan, bridge_cluster_id and ha_enable. Similarly, for creating a bridge endpoint on an edge cluster following properties will be used: vlan, bridge_endpoint_profile_id and vlan_transport_zone_id.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BridgeEndpoint", 
  "module_id": "BridgeEndpoint", 
  "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"
    }, 
    "bridge_cluster_id": {
      "description": "This field will not be used if an edge cluster is being used for the bridge endpoint", 
      "maxLength": 36, 
      "required": false, 
      "title": "UUID of the bridge cluster for this bridge endpoint", 
      "type": "string"
    }, 
    "bridge_endpoint_profile_id": {
      "description": "This field will not be used if a bridge cluster is being used for the bridge endpoint", 
      "required": false, 
      "title": "Bridge endpoint profile used by the edge cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "ha_enable": {
      "default": true, 
      "description": "This field will not be used if an edge cluster is being used for the bridge endpoint", 
      "required": false, 
      "title": "Controls the enabling of HA on the VLAN for this endpoint", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "uplink_teaming_policy_name": {
      "description": "This name has to be one of the switching uplink teaming policy names listed inside the TransportZone. If this field is not specified, bridge will use the first pnic in host-switch config. This field will not be used if a bridge cluster is being used for the bridge endpoint", 
      "required": false, 
      "title": "The name of the switching uplink teaming policy for the bridge endpoint", 
      "type": "string"
    }, 
    "vlan": {
      "$ref": "VlanID, 
      "description": "This property is used for VLAN specification of bridge endpoint. It's mutually exclusive with 'vlan_trunk_spec', either 'vlan' or 'vlan_trunk_spec' should be specified.", 
      "required": false
    }, 
    "vlan_transport_zone_id": {
      "description": "This field will not be used if a bridge cluster is being used for the bridge endpoint", 
      "required": false, 
      "title": "VLAN transport zone id by the edge cluster", 
      "type": "string"
    }, 
    "vlan_trunk_spec": {
      "$ref": "VlanTrunkSpec, 
      "description": "This property is used for VLAN trunk specification of edge bridge endpoint. It's mutually exclusive with 'vlan', either 'vlan' or 'vlan_trunk_spec' should be specified.", 
      "required": false, 
      "title": "VLAN trunk spec of edge bridge endpoint"
    }
  }, 
  "title": "Bridge Endpoint", 
  "type": "object"
}

BridgeEndpointListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BridgeEndpointListResult", 
  "module_id": "BridgeEndpoint", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BridgeEndpoint
      }, 
      "minItems": 0, 
      "readonly": true, 
      "required": true, 
      "title": "BridgeEndpoint Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint queries result", 
  "type": "object"
}

BridgeEndpointProfile (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "BridgeEndpointProfile", 
  "module_id": "BridgeEndpointProfile", 
  "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"
    }, 
    "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"
    }, 
    "edge_cluster_id": {
      "maxLength": 36, 
      "required": true, 
      "title": "UUID of the edge cluster for this bridge endpoint", 
      "type": "string"
    }, 
    "edge_cluster_member_indexes": {
      "description": "First index will be used as the preferred member", 
      "items": {
        "type": "int"
      }, 
      "required": false, 
      "title": "Indexes of the member hosts of the edge bridge cluster", 
      "type": "array"
    }, 
    "failover_mode": {
      "default": "PREEMPTIVE", 
      "description": "Faileover mode can be preemmptive or non-preemptive", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "required": false, 
      "title": "Failover mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "high_availability_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "High avaialability mode can be active-active or active-standby", 
      "enum": [
        "ACTIVE_STANDBY"
      ], 
      "required": false, 
      "title": "High availability mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Bridge Endpoint Profile", 
  "type": "object"
}

BridgeEndpointProfileListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BridgeEndpointProfileListResult", 
  "module_id": "BridgeEndpointProfile", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BridgeEndpointProfile
      }, 
      "minItems": 0, 
      "readonly": true, 
      "required": true, 
      "title": "BridgeEndpointProfile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint Profile queries result", 
  "type": "object"
}

BridgeEndpointProfileRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BridgeEndpointProfileRequestParameters", 
  "module_id": "BridgeEndpointProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "required": false, 
      "title": "Edge Cluster Identifier", 
      "type": "string"
    }, 
    "failover_mode": {
      "required": false, 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint Profile request parameters", 
  "type": "object"
}

BridgeEndpointRequestParameters (type)

{
  "description": "When querying for bridge endpoints on a bridge cluster, following parameters can be used: bridge_cluster_id and logical_switch_id. When querying for bridge endpoints on an edge cluster, following parameters can be used: bridge_endpoint_profile_id, vlan_transport_zone_id and logical_switch_id. When multiple parameters are provided they will be anded together. if bridge_cluster_id is used along with bridge_endpoint_profile_id or vlan_transport_zone_id an error will be thrown.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BridgeEndpointRequestParameters", 
  "module_id": "BridgeEndpoint", 
  "properties": {
    "bridge_cluster_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge cluster will be returned.", 
      "required": false, 
      "title": "Bridge Cluster Identifier", 
      "type": "string"
    }, 
    "bridge_endpoint_profile_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge endpoint profile will be returned.", 
      "required": false, 
      "title": "Bridge endpoint profile used by the edge cluster", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "description": "If provided, only bridge endpoints associated with the given logical switch will be returned.", 
      "required": false, 
      "title": "Logical Switch Identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vlan_transport_zone_id": {
      "description": "If provided, only bridge endpoints associated with the given transport zone will be returned.", 
      "required": false, 
      "title": "VLAN transport zone id used by the edge cluster", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint request parameters", 
  "type": "object"
}

BridgeEndpointStatistics (type)

{
  "extends": {
    "$ref": "AggregatedDataCounter
  }, 
  "id": "BridgeEndpointStatistics", 
  "module_id": "AggSvcBridging", 
  "properties": {
    "endpoint_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the bridge endpoint", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

BridgeEndpointStatus (type)

{
  "id": "BridgeEndpointStatus", 
  "module_id": "AggSvcBridging", 
  "properties": {
    "active_nodes": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "The Ids of the transport nodes which actively serve the endpoint.", 
      "type": "array"
    }, 
    "endpoint_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the bridge endpoint", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }
  }, 
  "type": "object"
}

BridgeHighAvailabilityClusterProfile (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "ClusterProfile
  }, 
  "id": "BridgeHighAvailabilityClusterProfile", 
  "module_id": "BridgeHighAvailabilityClusterProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BridgeHighAvailabilityClusterProfile"
  }, 
  "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"
    }, 
    "bfd_probe_interval": {
      "default": 1000, 
      "maximum": 60000, 
      "minimum": 300, 
      "required": false, 
      "title": "the time interval (in millisec) between probe packets for heartbeat purpose", 
      "type": "integer"
    }, 
    "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"
    }, 
    "enable": {
      "default": true, 
      "required": false, 
      "title": "whether the heartbeat is enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD HA cluster setting", 
  "type": "object"
}

BridgeProfileConfig (type)

{
  "additionalProperties": false, 
  "description": "configuration parameters for Bridge Profile", 
  "id": "BridgeProfileConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "bridge_profile_path": {
      "description": "Same bridge profile can be configured on different segments. Each bridge profile on a segment must unique.", 
      "required": true, 
      "title": "Policy path to L2 Bridge profile", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Segment"
          ], 
          "relationshipType": "SEGMENT_BRIDGE_PROFILE_RELATIONSHIP", 
          "rightType": [
            "L2BridgeEndpointProfile"
          ]
        }
      ]
    }, 
    "uplink_teaming_policy_name": {
      "description": "The name of the switching uplink teaming policy for the bridge endpoint. This name corresponds to one fot he switching uplink teaming policy names listed in teh transport zone. When this property is not specified, the teaming policy is assigned by MP.", 
      "title": "Uplink Teaming Policy Name", 
      "type": "string"
    }, 
    "vlan_ids": {
      "description": "VLAN specification for bridge endpoint. Either VLAN ID or VLAN ranges can be specified. Not both.", 
      "items": {
        "type": "string"
      }, 
      "title": "VLAN IDs", 
      "type": "array"
    }, 
    "vlan_transport_zone_path": {
      "description": "VLAN transport zone should belong to the enforcment-point as the transport zone specified in the segment.", 
      "required": true, 
      "title": "Policy path to VLAN Transport Zone", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Segment"
          ], 
          "relationshipType": "_UNOPTIMIZED_RELATIONSHIP_", 
          "rightType": [
            "PolicyTransportZone"
          ]
        }
      ]
    }
  }, 
  "title": "Bridge Profile Configuration", 
  "type": "object"
}

BridgeProfileRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "BridgeProfileRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "bridge_profile_path": {
      "description": "Policy path of Bridge profile using which a bridge end point was created.", 
      "required": true, 
      "title": "Bridge profile path", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path.", 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }
  }, 
  "title": "Bridge profile request parameters", 
  "type": "object"
}

BrokerProperties (type)

{
  "additionalProperties": false, 
  "id": "BrokerProperties", 
  "properties": {
    "BrokerFqdn": {
      "description": "Fully qualified domain name of the message bus broker on the management plane node.", 
      "required": false, 
      "type": "string"
    }, 
    "BrokerIpAddress": {
      "$ref": "HostnameOrIPv4Address, 
      "description": "IP address or hostname of the message bus broker on the management plane node.", 
      "readonly": false, 
      "required": true
    }, 
    "BrokerIsMaster": {
      "description": "Indicates whether this broker is the master.", 
      "type": "string"
    }, 
    "BrokerPort": {
      "description": "Port number of the message bus broker on the management plane node.", 
      "type": "string"
    }, 
    "BrokerSslCertThumbprint": {
      "description": "Certificate thumbprint of the message bus broker on the management plane node.", 
      "required": true, 
      "type": "string"
    }, 
    "BrokerVirtualHost": {
      "description": "Type of host running the broker.", 
      "type": "string"
    }
  }, 
  "title": "Information about a management plane node this transport node is configured to communicate with", 
  "type": "object"
}

BundleId (type)

{
  "additionalProperties": false, 
  "description": "Identifier of the bundle.", 
  "id": "BundleId", 
  "module_id": "FileUploadFramework", 
  "properties": {
    "bundle_id": {
      "description": "Identifier of bundle upload", 
      "readonly": true, 
      "required": false, 
      "title": "Bundle Id", 
      "type": "string"
    }
  }, 
  "title": "Id of bundle", 
  "type": "object"
}

BundleIds (type)

{
  "additionalProperties": false, 
  "description": "Contains a list of bundle-ids.", 
  "id": "BundleIds", 
  "module_id": "FileUploadFramework", 
  "properties": {
    "failed": {
      "description": "Id of a bundle whose upload was failed.", 
      "readonly": true, 
      "required": false, 
      "title": "Failed bundle-Id", 
      "type": "string"
    }, 
    "in_progress": {
      "description": "Id of a bundle whose upload is in-progress.", 
      "readonly": true, 
      "required": false, 
      "title": "In-progress bundle-Id", 
      "type": "string"
    }, 
    "successful": {
      "description": "Id of a bundle whose upload is successful.", 
      "readonly": true, 
      "required": false, 
      "title": "Sucessful bundle-Id", 
      "type": "string"
    }
  }, 
  "title": "List of bundle-ids", 
  "type": "object"
}

BundleUploadParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameters specified during bundle upload operations.", 
  "extends": {
    "$ref": "ProductType
  }, 
  "id": "BundleUploadParameters", 
  "module_id": "FileUploadFramework", 
  "properties": {
    "file_type": {
      "description": "Type of file which will be uploaded.", 
      "enum": [
        "OVA"
      ], 
      "required": true, 
      "title": "Type of file", 
      "type": "string"
    }, 
    "product": {
      "description": "Name of the appliance for which upload is performed.", 
      "enum": [
        "SAMPLE", 
        "ALB_CONTROLLER", 
        "INTELLIGENCE"
      ], 
      "required": true, 
      "title": "Name of the appliance", 
      "type": "string"
    }
  }, 
  "title": "Parameters for bundle upload", 
  "type": "object"
}

BundleUploadPermission (type)

{
  "additionalProperties": false, 
  "description": "Describes whether bundle upload is allowed or not.", 
  "id": "BundleUploadPermission", 
  "module_id": "FileUploadFramework", 
  "properties": {
    "reason": {
      "description": "Reason for not allowing upload.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "upload_allowed": {
      "description": "Flag indication whether upload is allowed or not.", 
      "readonly": true, 
      "required": true, 
      "title": "Bundle upload allowed flag", 
      "type": "boolean"
    }
  }, 
  "title": "Permissions for bundle upload", 
  "type": "object"
}

BundleUploadStatus (type)

{
  "additionalProperties": false, 
  "description": "Upload status of bundle uploaded from local or remote location.", 
  "id": "BundleUploadStatus", 
  "module_id": "FileUploadFramework", 
  "properties": {
    "bundle_name": {
      "description": "Name of the uploaded bundle.", 
      "readonly": true, 
      "required": false, 
      "title": "Name of the bundle", 
      "type": "string"
    }, 
    "detailed_status": {
      "description": "Detailed status of bundle upload.", 
      "readonly": true, 
      "required": false, 
      "title": "Detailed status of bundle upload", 
      "type": "string"
    }, 
    "percent": {
      "description": "Percent of bundle uploaded from remote location.", 
      "readonly": true, 
      "required": false, 
      "title": "Percent of upload completed", 
      "type": "number"
    }, 
    "status": {
      "description": "Current status of bundle upload.", 
      "enum": [
        "UPLOADING", 
        "VERIFYING", 
        "SUCCESS", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of bundle upload", 
      "type": "string"
    }, 
    "url": {
      "description": "URL for uploading bundle.", 
      "readonly": true, 
      "required": false, 
      "title": "URL from which the bundle was uploaded", 
      "type": "string"
    }
  }, 
  "title": "Upload status of bundle", 
  "type": "object"
}

ByodPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Represents an instance of partner's service whose wiring will be done by partner itself. As partner does all the wiring, we call it as Byod - Bring your own device.", 
  "extends": {
    "$ref": "BasePolicyServiceInstance
  }, 
  "id": "ByodPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "policy_hierarchical_children": [
    "ChildServiceInstanceEndpoint"
  ], 
  "polymorphic-type-descriptor": {
    "type-identifier": "ByodPolicyServiceInstance"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service in the Marketplace", 
      "required": true, 
      "title": "Name of Partner Service", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "default": "L2_BRIDGE", 
      "description": "Transport to be used while deploying Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Transport Type", 
      "type": "string"
    }, 
    "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": "Represents instance of self wiring partner's service", 
  "type": "object"
}

ByodPolicyServiceInstanceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ByodPolicyServiceInstanceListResult", 
  "module_id": "PolicyServiceInsertion", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ByodPolicyServiceInstance
      }, 
      "required": true, 
      "title": "Byod Service instance list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Collection of only Byod SI objects", 
  "type": "object"
}

ByodServiceInstance (type)

{
  "description": "ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX.", 
  "extends": {
    "$ref": "BaseServiceInstance
  }, 
  "id": "ByodServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ByodServiceInstance"
  }, 
  "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"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "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"
    }, 
    "on_failure_policy": {
      "description": "Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED", 
        "NSH", 
        "NA"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Custom Instance of a service", 
  "type": "object"
}

CCPUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus
  }, 
  "id": "CCPUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_rollback": {
      "description": "This field indicates whether we can perform upgrade rollback.", 
      "readonly": true, 
      "required": false, 
      "title": "Can perform rollback", 
      "type": "boolean"
    }, 
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "title": "Status of CCP upgrade", 
  "type": "object"
}

CCSnmpV3User (type)

{
  "additionalProperties": false, 
  "description": "This object contains properties for a SNMP V3 user that can be used to receive SNMP traps/notifications from NSX and/or poll NSX nodes over SNMP.", 
  "id": "CCSnmpV3User", 
  "module_id": "CentralConfig", 
  "properties": {
    "access": {
      "default": "READ_ONLY", 
      "description": "Access permissions for polling NSX nodes over SNMP V3.", 
      "enum": [
        "READ_ONLY"
      ], 
      "title": "Type of access", 
      "type": "string"
    }, 
    "auth_password": {
      "description": "Authentication password used for SNMP V3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for authentication password.", 
      "required": false, 
      "sensitive": true, 
      "title": "Authentication password", 
      "type": "secure_string"
    }, 
    "priv_password": {
      "description": "Privacy password used for SNMP V3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for privacy password.", 
      "required": false, 
      "sensitive": true, 
      "title": "Privacy password", 
      "type": "secure_string"
    }, 
    "security_level": {
      "default": "AUTH_PRIV", 
      "description": "Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.", 
      "enum": [
        "AUTH_PRIV"
      ], 
      "title": "Security level", 
      "type": "string"
    }, 
    "user_id": {
      "description": "Unique SNMP V3 user id.", 
      "maxLength": 32, 
      "minLength": 1, 
      "required": true, 
      "title": "User ID", 
      "type": "string"
    }
  }, 
  "title": "SNMP V3 user", 
  "type": "object"
}

CNSGroupAssociationRequestParams (type)

{
  "additionalProperties": false, 
  "description": "List request parameters containing Cloud Native service external ID and enforcement point path", 
  "extends": {
    "$ref": "RealizationListRequestParameters
  }, 
  "id": "CNSGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cns_external_id": {
      "required": true, 
      "title": "Cloud Native Service external ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing Cloud Native Service external ID and enforcement point path", 
  "type": "object"
}

CPUReservation (type)

{
  "description": "Relative to the form factor pre-defined reservation value. We recommended that you use the predefined measures of CPU reservation shares to reduce the CPU reservation of a VM. Reservation shares are relative to the default form-factor value. Though absolute values for CPU reservation is supported, we advise to use this option with caution as incorrect or high reservation values could lead to deployment failure or lead to resource starvation for other VMs running on the same host.", 
  "id": "CPUReservation", 
  "module_id": "FabricNode", 
  "properties": {
    "reservation_in_mhz": {
      "description": "The CPU reservation in MHz is the guaranteed minimum amount of clock cycles that the vmkernel CPU scheduler will give the Edge VM in case of contention. If an Edge VM is not using its reserved resources, then other machines can use them thus preventing waste of CPU cycles on the physical host. Note: We recommend use of reservation_in_shares instead of this absolute configuration. When you specify this value, set reservation_in_shares to LOW_PRIORITY.", 
      "required": false, 
      "title": "CPU reservation in MHz.", 
      "type": "int"
    }, 
    "reservation_in_shares": {
      "default": "HIGH_PRIORITY", 
      "description": "Shares specify the relative importance of a virtual machine on a given host. When you assign shares to a virtual machine, you always specify the priority for that virtual machine relative to other powered-on virtual machines on the same host. The default priority for shares is HIGH_PRIORITY.", 
      "enum": [
        "EXTRA_HIGH_PRIORITY", 
        "HIGH_PRIORITY", 
        "NORMAL_PRIORITY", 
        "LOW_PRIORITY"
      ], 
      "required": false, 
      "title": "CPU reservation in shares.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CaBundle (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CaBundle", 
  "module_id": "PolicyCertificate", 
  "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"
    }, 
    "certificates": {
      "description": "X509Certificates in the bundle", 
      "items": {
        "$ref": "X509Certificate
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "earliest_not_after": {
      "$ref": "EpochMsTimestamp, 
      "description": "The earliest time in epoch milliseconds at which a certificate becomes invalid.", 
      "readonly": true, 
      "required": false
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "not_after_list": {
      "description": "Times for each certificate in the bundle at which the certificate becomes invalid.", 
      "items": {
        "$ref": "EpochMsTimestamp
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "pem_encoded": {
      "description": "PEM-encoded CA bundle certificates.", 
      "readonly": false, 
      "required": true, 
      "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "CA certificates bundle", 
  "type": "object"
}

CaBundleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CaBundleListResult", 
  "module_id": "PolicyCertificate", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CA bundles list.", 
      "items": {
        "$ref": "CaBundle
      }, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CA Bundle query result", 
  "type": "object"
}

CallbackAuthenticationScheme (type)

{
  "description": "CallbackAuthenticationScheme describes how notification requests should authenticate to the server.", 
  "id": "CallbackAuthenticationScheme", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "certificate_id": {
      "description": "Certificate ID with a valid certificate and private key, procured from trust-management API.", 
      "readonly": false, 
      "title": "Valid certificate ID", 
      "type": "string"
    }, 
    "password": {
      "description": "Password to use if scheme_name is BASIC_AUTH.", 
      "readonly": false, 
      "sensitive": true, 
      "title": "Password for authentication", 
      "type": "secure_string"
    }, 
    "scheme_name": {
      "description": "Authentication scheme to use when making notification requests to the partner console. Specify one of BASIC_AUTH or CERTIFICATE.", 
      "enum": [
        "BASIC_AUTH", 
        "CERTIFICATE"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Authentication scheme to use when making notification requests", 
      "type": "string"
    }, 
    "username": {
      "description": "Username to use if scheme_name is BASIC_AUTH.", 
      "readonly": false, 
      "title": "Username for authentication", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CapacityDashboardUsage (type)

{
  "id": "CapacityDashboardUsage", 
  "module_id": "CapacityDashboard", 
  "properties": {
    "current_usage_count": {
      "description": "Indicate the current usage count of object type.", 
      "required": true, 
      "title": "Current usage count of object type", 
      "type": "integer"
    }, 
    "current_usage_percentage": {
      "description": "Current usage percentage for object type", 
      "required": true, 
      "title": "Current usage percentage", 
      "type": "number"
    }, 
    "display_name": {
      "description": "Display name for NSX object type.", 
      "required": true, 
      "title": "User friendly name for object type", 
      "type": "string"
    }, 
    "max_supported_count": {
      "description": "This is the maximum supported count for object type in consideration.", 
      "required": true, 
      "title": "Maximum supported count for object type", 
      "type": "integer"
    }, 
    "max_threshold_percentage": {
      "description": "This indicates the maximum threshold percentage for object type.", 
      "required": true, 
      "title": "Max threshold percentage for object type", 
      "type": "number"
    }, 
    "min_threshold_percentage": {
      "description": "This indicates the minimum threshold percentage for object type.", 
      "required": true, 
      "title": "Min threshold percentage for object type", 
      "type": "number"
    }, 
    "severity": {
      "description": "Severity calculated from percentage usage", 
      "enum": [
        "INFO", 
        "WARNING", 
        "CRITICAL", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Severity calculated from percentage usage", 
      "type": "string"
    }, 
    "usage_type": {
      "description": "Indicate the object type for which usage is calculated.", 
      "required": true, 
      "title": "Object type for which usage is fetched", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CapacityThreshold (type)

{
  "id": "CapacityThreshold", 
  "module_id": "CapacityDashboard", 
  "properties": {
    "max_threshold_percentage": {
      "description": "Set the maximum threshold percentage. Specify a value between 0 and 100. Usage percentage above this value is tagged as critical.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": true, 
      "title": "Maximum threshold percentage", 
      "type": "number"
    }, 
    "min_threshold_percentage": {
      "description": "Set the minimum threshold percentage. Specify a value between 0 and 100. Usage percentage above this value is tagged as warning.", 
      "maximum": 100, 
      "minimum": 0, 
      "required": true, 
      "title": "Minimum threshold percentage", 
      "type": "number"
    }, 
    "threshold_type": {
      "description": "Indicate the object type for which threshold is to be set.", 
      "required": true, 
      "title": "Object type for which threshold is to be set", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CapacityThresholdList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CapacityThresholdList", 
  "module_id": "CapacityDashboard", 
  "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"
    }, 
    "capacity_thresholds": {
      "items": {
        "$ref": "CapacityThreshold
      }, 
      "required": true, 
      "title": "List of capacity thresholds for NSX Objects", 
      "type": "array"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CapacityUsage (type)

{
  "description": "usage of each capacity type ex. vm, cpu", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CapacityUsage", 
  "module_id": "License", 
  "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"
    }, 
    "capacity_type": {
      "readonly": true, 
      "title": "type of the capacity field", 
      "type": "string"
    }, 
    "usage_count": {
      "readonly": true, 
      "title": "count of number of items of capacity_type", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

CapacityUsageMetaInfo (type)

{
  "additionalProperties": false, 
  "id": "CapacityUsageMetaInfo", 
  "module_id": "CapacityDashboard", 
  "properties": {
    "last_updated_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "Timestamp at which capacity usage was last calculated"
    }, 
    "max_global_threshold_percentage": {
      "description": "Indicates the maximum global threshold percentage", 
      "required": true, 
      "title": "Maximum global threshold percentage", 
      "type": "number"
    }, 
    "min_global_threshold_percentage": {
      "description": "Indicates the minimum global threshold percentage", 
      "required": true, 
      "title": "Minimum global threshold percentage", 
      "type": "number"
    }
  }, 
  "type": "object"
}

CapacityUsageRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "CapacityUsageRequestParameters", 
  "module_id": "CapacityDashboard", 
  "properties": {
    "category": {
      "description": "Category of attributes for which capacity details need to be fetched. Supported categories are security, inventory, networking and system. User can provide comma separated list of multiple categories.", 
      "required": false, 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "force": {
      "default": false, 
      "description": "Parameter to force inline calculation instead of retrieving cached results.", 
      "required": false, 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Parameter to force inline calculation.", 
  "type": "object"
}

CapacityUsageResponse (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CapacityUsageResponse", 
  "module_id": "CapacityDashboard", 
  "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"
    }, 
    "capacity_usage": {
      "items": {
        "$ref": "CapacityDashboardUsage
      }, 
      "required": true, 
      "title": "List of capacity usage for NSX Objects", 
      "type": "array"
    }, 
    "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"
    }, 
    "meta_info": {
      "extends": {
        "$ref": "CapacityUsageMetaInfo
      }, 
      "required": true, 
      "title": "Meta data for capacity usage statistics", 
      "type": "object"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unreported_usage_types": {
      "description": "Types for which usage data was not reported", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Unreported usage types", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CdpStatusType (type)

{
  "enum": [
    "NOT_READY", 
    "FETCHING", 
    "READY", 
    "ERROR"
  ], 
  "id": "CdpStatusType", 
  "module_id": "CertificateManager", 
  "title": "Status types supported of the CrlDistributionPoint", 
  "type": "string"
}

CentralConfigProperties (type)

{
  "id": "CentralConfigProperties", 
  "properties": {
    "local_override": {
      "required": true, 
      "title": "Override Central Config", 
      "type": "boolean"
    }
  }, 
  "title": "Central Config properties", 
  "type": "object"
}

CentralNodeConfigProfile (type)

{
  "additionalProperties": false, 
  "description": "Central Node Config profile for NSX nodes. This set of properties will be pushed to NSX Manager and Edge nodes. SNMP properties will be pushed to KVM Hypervisors in addition to Manager and Edge nodes.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CentralNodeConfigProfile", 
  "module_id": "CentralConfig", 
  "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"
    }, 
    "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"
    }, 
    "ntp": {
      "$ref": "NtpProperties, 
      "description": "NTP service properties for NSX nodes.", 
      "required": false, 
      "title": "NTP service properties"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "snmp": {
      "$ref": "SnmpProperties, 
      "description": "SNMP service properties for NSX nodes.", 
      "required": false, 
      "title": "SNMP service properties"
    }, 
    "syslog": {
      "$ref": "SyslogProperties, 
      "description": "Syslog service properties for NSX nodes.", 
      "required": false, 
      "title": "Syslog service properties"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timezone": {
      "description": "Timezone to be set for NSX nodes. Only timezone strings listed in the Time Zone database (https://www.iana.org/time-zones) are allowed.", 
      "required": false, 
      "title": "Timezone", 
      "type": "string"
    }
  }, 
  "title": "Central Node Config Profile", 
  "type": "object"
}

CentralNodeConfigProfileGetRequestParams (type)

{
  "additionalProperties": false, 
  "description": "This object includes GET request parameter to indicate whether sensitive data should be returned for a central Central Node Config profile.", 
  "id": "CentralNodeConfigProfileGetRequestParams", 
  "module_id": "CentralConfig", 
  "properties": {
    "show_sensitive_data": {
      "default": false, 
      "description": "If set to true, Central Node Config profile includes sensitive data properties like SNMP community strings if any applicable. Note that passwords are never returned. Default set to false.", 
      "required": false, 
      "title": "Show sensitive data in Central Node Config profile", 
      "type": "boolean"
    }
  }, 
  "title": "GET request parameters for Central Node Config profile", 
  "type": "object"
}

CentralNodeConfigProfileListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of Central Node Config profiles.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CentralNodeConfigProfileListResult", 
  "module_id": "CentralConfig", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CentralNodeConfigProfile
      }, 
      "required": true, 
      "title": "Central Node Config profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Central Node Config profiles", 
  "type": "object"
}

Certificate (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Certificate", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "description": "List of X509Certificates.", 
      "items": {
        "$ref": "X509Certificate
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "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"
    }, 
    "has_private_key": {
      "default": false, 
      "description": "Whether we have the private key for this certificate.", 
      "readonly": true, 
      "required": true, 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "leaf_certificate_sha_256_thumbprint": {
      "description": "Unique SHA-256 thumbprint of the leaf node certificate.", 
      "readonly": true, 
      "required": false, 
      "title": "Certificate thumbprint", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "purpose": {
      "description": "Purpose of this certificate. Can be empty or set to \"signing-ca\".", 
      "enum": [
        "signing-ca"
      ], 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "used_by": {
      "description": "List of node IDs with services, that are using this certificate.", 
      "items": {
        "$ref": "NodeIdServicesMap
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

CertificateCheckingStatus (type)

{
  "additionalProperties": false, 
  "id": "CertificateCheckingStatus", 
  "module_id": "CertificateManager", 
  "properties": {
    "error_message": {
      "description": "Error message when checking the certificate.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "status": {
      "$ref": "CertificateCheckingStatusType, 
      "description": "Status of the checked certificate.", 
      "readonly": true, 
      "required": true, 
      "title": "Status"
    }
  }, 
  "title": "Result of checking a certificate", 
  "type": "object"
}

CertificateCheckingStatusType (type)

{
  "enum": [
    "OK", 
    "CRL_NOT_READY", 
    "REJECTED", 
    "ERROR"
  ], 
  "id": "CertificateCheckingStatusType", 
  "module_id": "CertificateManager", 
  "title": "Status types returned when checking a certificate", 
  "type": "string"
}

CertificateData (type)

{
  "additionalProperties": false, 
  "id": "CertificateData", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": false, 
      "required": true, 
      "title": "PEM encoded certificate data", 
      "type": "string"
    }, 
    "private_key": {
      "description": "Private key of certificate.", 
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "Private key of certificate", 
      "type": "secure_string"
    }
  }, 
  "type": "object"
}

CertificateId (type)

{
  "additionalProperties": false, 
  "id": "CertificateId", 
  "properties": {
    "certificate_id": {
      "readonly": true, 
      "required": true, 
      "title": "Certificate ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CertificateKeyPair (type)

{
  "additionalProperties": false, 
  "id": "CertificateKeyPair", 
  "properties": {
    "certificate": {
      "$ref": "SecurityCertificate, 
      "display": {
        "order": 1
      }, 
      "readonly": false, 
      "required": true
    }, 
    "rsa_private_key": {
      "description": "The private key must include the enclosing \"-----BEGIN RSA PRIVATE KEY-----\" and \"-----END RSA PRIVATE KEY-----\". An empty string is returned in read responses.", 
      "display": {
        "order": 2
      }, 
      "minLength": 60, 
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "PEM encoded RSA private key", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CertificateList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CertificateList", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Certificate list.", 
      "items": {
        "$ref": "Certificate
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Certificate queries result", 
  "type": "object"
}

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"
    }, 
    "cluster_certificate": {
      "description": "True if this is for a cluster certificate", 
      "readonly": true, 
      "required": true, 
      "title": "Cluster Certificate", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "profile_name": {
      "readonly": true, 
      "required": true, 
      "title": "Certificate Profile Name", 
      "type": "string"
    }, 
    "service_type": {
      "$ref": "ServiceType, 
      "readonly": true, 
      "required": true, 
      "title": "Unique Service Type"
    }, 
    "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"
}

CertificateProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CertificateProfileListResult", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CertificateProfile list.", 
      "items": {
        "$ref": "CertificateProfile
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CertificateProfile query result", 
  "type": "object"
}

CertificateUsageType (type)

{
  "enum": [
    "SERVER", 
    "CLIENT"
  ], 
  "id": "CertificateUsageType", 
  "module_id": "CertificateManager", 
  "title": "Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER", 
  "type": "string"
}

ChildALBAlertScriptConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBAlertScriptConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBAlertScriptConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBAlertScriptConfig"
  }, 
  "properties": {
    "ALBAlertScriptConfig": {
      "$ref": "ALBAlertScriptConfig, 
      "description": "Contains the actual ALBAlertScriptConfig object.", 
      "required": true, 
      "title": "ChildALBAlertScriptConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBAlertScriptConfig", 
  "type": "object"
}

ChildALBAnalyticsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBAnalyticsProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBAnalyticsProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBAnalyticsProfile"
  }, 
  "properties": {
    "ALBAnalyticsProfile": {
      "$ref": "ALBAnalyticsProfile, 
      "description": "Contains the actual ALBAnalyticsProfile object.", 
      "required": true, 
      "title": "ChildALBAnalyticsProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBAnalyticsProfile", 
  "type": "object"
}

ChildALBApplicationPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBApplicationPersistenceProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBApplicationPersistenceProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBApplicationPersistenceProfile"
  }, 
  "properties": {
    "ALBApplicationPersistenceProfile": {
      "$ref": "ALBApplicationPersistenceProfile, 
      "description": "Contains the actual ALBApplicationPersistenceProfile object.", 
      "required": true, 
      "title": "ChildALBApplicationPersistenceProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBApplicationPersistenceProfile", 
  "type": "object"
}

ChildALBApplicationProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBApplicationProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBApplicationProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBApplicationProfile"
  }, 
  "properties": {
    "ALBApplicationProfile": {
      "$ref": "ALBApplicationProfile, 
      "description": "Contains the actual ALBApplicationProfile object.", 
      "required": true, 
      "title": "ChildALBApplicationProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBApplicationProfile", 
  "type": "object"
}

ChildALBAuthProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBAuthProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBAuthProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBAuthProfile"
  }, 
  "properties": {
    "ALBAuthProfile": {
      "$ref": "ALBAuthProfile, 
      "description": "Contains the actual ALBAuthProfile object.", 
      "required": true, 
      "title": "ChildALBAuthProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBAuthProfile", 
  "type": "object"
}

ChildALBAutoScaleLaunchConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBAutoScaleLaunchConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBAutoScaleLaunchConfig", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBAutoScaleLaunchConfig"
  }, 
  "properties": {
    "ALBAutoScaleLaunchConfig": {
      "$ref": "ALBAutoScaleLaunchConfig, 
      "description": "Contains the actual ALBAutoScaleLaunchConfig object.", 
      "required": true, 
      "title": "ChildALBAutoScaleLaunchConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBAutoScaleLaunchConfig", 
  "type": "object"
}

ChildALBCertificateManagementProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBCertificateManagementProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBCertificateManagementProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBCertificateManagementProfile"
  }, 
  "properties": {
    "ALBCertificateManagementProfile": {
      "$ref": "ALBCertificateManagementProfile, 
      "description": "Contains the actual ALBCertificateManagementProfile object.", 
      "required": true, 
      "title": "ChildALBCertificateManagementProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBCertificateManagementProfile", 
  "type": "object"
}

ChildALBDnsPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBDnsPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBDnsPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBDnsPolicy"
  }, 
  "properties": {
    "ALBDnsPolicy": {
      "$ref": "ALBDnsPolicy, 
      "description": "Contains the actual ALBDnsPolicy object.", 
      "required": true, 
      "title": "ChildALBDnsPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBDnsPolicy", 
  "type": "object"
}

ChildALBErrorPageBody (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBErrorPageBody, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBErrorPageBody", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBErrorPageBody"
  }, 
  "properties": {
    "ALBErrorPageBody": {
      "$ref": "ALBErrorPageBody, 
      "description": "Contains the actual ALBErrorPageBody object.", 
      "required": true, 
      "title": "ChildALBErrorPageBody"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBErrorPageBody", 
  "type": "object"
}

ChildALBErrorPageProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBErrorPageProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBErrorPageProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBErrorPageProfile"
  }, 
  "properties": {
    "ALBErrorPageProfile": {
      "$ref": "ALBErrorPageProfile, 
      "description": "Contains the actual ALBErrorPageProfile object.", 
      "required": true, 
      "title": "ChildALBErrorPageProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBErrorPageProfile", 
  "type": "object"
}

ChildALBHTTPPolicySet (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBHTTPPolicySet, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBHTTPPolicySet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBHTTPPolicySet"
  }, 
  "properties": {
    "ALBHTTPPolicySet": {
      "$ref": "ALBHTTPPolicySet, 
      "description": "Contains the actual ALBHTTPPolicySet object.", 
      "required": true, 
      "title": "ChildALBHTTPPolicySet"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBHTTPPolicySet", 
  "type": "object"
}

ChildALBHardwareSecurityModuleGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBHardwareSecurityModuleGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBHardwareSecurityModuleGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBHardwareSecurityModuleGroup"
  }, 
  "properties": {
    "ALBHardwareSecurityModuleGroup": {
      "$ref": "ALBHardwareSecurityModuleGroup, 
      "description": "Contains the actual ALBHardwareSecurityModuleGroup object.", 
      "required": true, 
      "title": "ChildALBHardwareSecurityModuleGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBHardwareSecurityModuleGroup", 
  "type": "object"
}

ChildALBHealthMonitor (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBHealthMonitor, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBHealthMonitor", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBHealthMonitor"
  }, 
  "properties": {
    "ALBHealthMonitor": {
      "$ref": "ALBHealthMonitor, 
      "description": "Contains the actual ALBHealthMonitor object.", 
      "required": true, 
      "title": "ChildALBHealthMonitor"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBHealthMonitor", 
  "type": "object"
}

ChildALBIpAddrGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBIpAddrGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBIpAddrGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBIpAddrGroup"
  }, 
  "properties": {
    "ALBIpAddrGroup": {
      "$ref": "ALBIpAddrGroup, 
      "description": "Contains the actual ALBIpAddrGroup object.", 
      "required": true, 
      "title": "ChildALBIpAddrGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBIpAddrGroup", 
  "type": "object"
}

ChildALBL4PolicySet (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBL4PolicySet, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBL4PolicySet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBL4PolicySet"
  }, 
  "properties": {
    "ALBL4PolicySet": {
      "$ref": "ALBL4PolicySet, 
      "description": "Contains the actual ALBL4PolicySet object.", 
      "required": true, 
      "title": "ChildALBL4PolicySet"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBL4PolicySet", 
  "type": "object"
}

ChildALBNetworkProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBNetworkProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBNetworkProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBNetworkProfile"
  }, 
  "properties": {
    "ALBNetworkProfile": {
      "$ref": "ALBNetworkProfile, 
      "description": "Contains the actual ALBNetworkProfile object.", 
      "required": true, 
      "title": "ChildALBNetworkProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBNetworkProfile", 
  "type": "object"
}

ChildALBNetworkSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBNetworkSecurityPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBNetworkSecurityPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBNetworkSecurityPolicy"
  }, 
  "properties": {
    "ALBNetworkSecurityPolicy": {
      "$ref": "ALBNetworkSecurityPolicy, 
      "description": "Contains the actual ALBNetworkSecurityPolicy object.", 
      "required": true, 
      "title": "ChildALBNetworkSecurityPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBNetworkSecurityPolicy", 
  "type": "object"
}

ChildALBPKIProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBPKIProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBPKIProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBPKIProfile"
  }, 
  "properties": {
    "ALBPKIProfile": {
      "$ref": "ALBPKIProfile, 
      "description": "Contains the actual ALBPKIProfile object.", 
      "required": true, 
      "title": "ChildALBPKIProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBPKIProfile", 
  "type": "object"
}

ChildALBPool (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBPool, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBPool", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBPool"
  }, 
  "properties": {
    "ALBPool": {
      "$ref": "ALBPool, 
      "description": "Contains the actual ALBPool object.", 
      "required": true, 
      "title": "ChildALBPool"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBPool", 
  "type": "object"
}

ChildALBPoolGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBPoolGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBPoolGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBPoolGroup"
  }, 
  "properties": {
    "ALBPoolGroup": {
      "$ref": "ALBPoolGroup, 
      "description": "Contains the actual ALBPoolGroup object.", 
      "required": true, 
      "title": "ChildALBPoolGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBPoolGroup", 
  "type": "object"
}

ChildALBPoolGroupDeploymentPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBPoolGroupDeploymentPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBPoolGroupDeploymentPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBPoolGroupDeploymentPolicy"
  }, 
  "properties": {
    "ALBPoolGroupDeploymentPolicy": {
      "$ref": "ALBPoolGroupDeploymentPolicy, 
      "description": "Contains the actual ALBPoolGroupDeploymentPolicy object.", 
      "required": true, 
      "title": "ChildALBPoolGroupDeploymentPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBPoolGroupDeploymentPolicy", 
  "type": "object"
}

ChildALBPriorityLabels (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBPriorityLabels, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBPriorityLabels", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBPriorityLabels"
  }, 
  "properties": {
    "ALBPriorityLabels": {
      "$ref": "ALBPriorityLabels, 
      "description": "Contains the actual ALBPriorityLabels object.", 
      "required": true, 
      "title": "ChildALBPriorityLabels"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBPriorityLabels", 
  "type": "object"
}

ChildALBProtocolParser (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBProtocolParser, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBProtocolParser", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBProtocolParser"
  }, 
  "properties": {
    "ALBProtocolParser": {
      "$ref": "ALBProtocolParser, 
      "description": "Contains the actual ALBProtocolParser object.", 
      "required": true, 
      "title": "ChildALBProtocolParser"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBProtocolParser", 
  "type": "object"
}

ChildALBSSLKeyAndCertificate (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBSSLKeyAndCertificate, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBSSLKeyAndCertificate", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBSSLKeyAndCertificate"
  }, 
  "properties": {
    "ALBSSLKeyAndCertificate": {
      "$ref": "ALBSSLKeyAndCertificate, 
      "description": "Contains the actual ALBSSLKeyAndCertificate object.", 
      "required": true, 
      "title": "ChildALBSSLKeyAndCertificate"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBSSLKeyAndCertificate", 
  "type": "object"
}

ChildALBSSLProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBSSLProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBSSLProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBSSLProfile"
  }, 
  "properties": {
    "ALBSSLProfile": {
      "$ref": "ALBSSLProfile, 
      "description": "Contains the actual ALBSSLProfile object.", 
      "required": true, 
      "title": "ChildALBSSLProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBSSLProfile", 
  "type": "object"
}

ChildALBSSOPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBSSOPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBSSOPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBSSOPolicy"
  }, 
  "properties": {
    "ALBSSOPolicy": {
      "$ref": "ALBSSOPolicy, 
      "description": "Contains the actual ALBSSOPolicy object.", 
      "required": true, 
      "title": "ChildALBSSOPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBSSOPolicy", 
  "type": "object"
}

ChildALBSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBSecurityPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBSecurityPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBSecurityPolicy"
  }, 
  "properties": {
    "ALBSecurityPolicy": {
      "$ref": "ALBSecurityPolicy, 
      "description": "Contains the actual ALBSecurityPolicy object.", 
      "required": true, 
      "title": "ChildALBSecurityPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBSecurityPolicy", 
  "type": "object"
}

ChildALBServerAutoScalePolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBServerAutoScalePolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBServerAutoScalePolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBServerAutoScalePolicy"
  }, 
  "properties": {
    "ALBServerAutoScalePolicy": {
      "$ref": "ALBServerAutoScalePolicy, 
      "description": "Contains the actual ALBServerAutoScalePolicy object.", 
      "required": true, 
      "title": "ChildALBServerAutoScalePolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBServerAutoScalePolicy", 
  "type": "object"
}

ChildALBStringGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBStringGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBStringGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBStringGroup"
  }, 
  "properties": {
    "ALBStringGroup": {
      "$ref": "ALBStringGroup, 
      "description": "Contains the actual ALBStringGroup object.", 
      "required": true, 
      "title": "ChildALBStringGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBStringGroup", 
  "type": "object"
}

ChildALBTrafficCloneProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBTrafficCloneProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBTrafficCloneProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBTrafficCloneProfile"
  }, 
  "properties": {
    "ALBTrafficCloneProfile": {
      "$ref": "ALBTrafficCloneProfile, 
      "description": "Contains the actual ALBTrafficCloneProfile object.", 
      "required": true, 
      "title": "ChildALBTrafficCloneProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBTrafficCloneProfile", 
  "type": "object"
}

ChildALBVSDataScriptSet (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBVSDataScriptSet, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBVSDataScriptSet", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBVSDataScriptSet"
  }, 
  "properties": {
    "ALBVSDataScriptSet": {
      "$ref": "ALBVSDataScriptSet, 
      "description": "Contains the actual ALBVSDataScriptSet object.", 
      "required": true, 
      "title": "ChildALBVSDataScriptSet"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBVSDataScriptSet", 
  "type": "object"
}

ChildALBVirtualService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBVirtualService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBVirtualService", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBVirtualService"
  }, 
  "properties": {
    "ALBVirtualService": {
      "$ref": "ALBVirtualService, 
      "description": "Contains the actual ALBVirtualService object.", 
      "required": true, 
      "title": "ChildALBVirtualService"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBVirtualService", 
  "type": "object"
}

ChildALBVsVip (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBVsVip, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBVsVip", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBVsVip"
  }, 
  "properties": {
    "ALBVsVip": {
      "$ref": "ALBVsVip, 
      "description": "Contains the actual ALBVsVip object.", 
      "required": true, 
      "title": "ChildALBVsVip"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBVsVip", 
  "type": "object"
}

ChildALBWafCRS (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBWafCRS, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBWafCRS", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBWafCRS"
  }, 
  "properties": {
    "ALBWafCRS": {
      "$ref": "ALBWafCRS, 
      "description": "Contains the actual ALBWafCRS object.", 
      "required": true, 
      "title": "ChildALBWafCRS"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBWafCRS", 
  "type": "object"
}

ChildALBWafPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBWafPolicy, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBWafPolicy", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBWafPolicy"
  }, 
  "properties": {
    "ALBWafPolicy": {
      "$ref": "ALBWafPolicy, 
      "description": "Contains the actual ALBWafPolicy object.", 
      "required": true, 
      "title": "ChildALBWafPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBWafPolicy", 
  "type": "object"
}

ChildALBWafPolicyPSMGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBWafPolicyPSMGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBWafPolicyPSMGroup", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBWafPolicyPSMGroup"
  }, 
  "properties": {
    "ALBWafPolicyPSMGroup": {
      "$ref": "ALBWafPolicyPSMGroup, 
      "description": "Contains the actual ALBWafPolicyPSMGroup object.", 
      "required": true, 
      "title": "ChildALBWafPolicyPSMGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBWafPolicyPSMGroup", 
  "type": "object"
}

ChildALBWafProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBWafProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBWafProfile", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBWafProfile"
  }, 
  "properties": {
    "ALBWafProfile": {
      "$ref": "ALBWafProfile, 
      "description": "Contains the actual ALBWafProfile object.", 
      "required": true, 
      "title": "ChildALBWafProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBWafProfile", 
  "type": "object"
}

ChildALBWebhook (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for ALBWebhook, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildALBWebhook", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildALBWebhook"
  }, 
  "properties": {
    "ALBWebhook": {
      "$ref": "ALBWebhook, 
      "description": "Contains the actual ALBWebhook object.", 
      "required": true, 
      "title": "ChildALBWebhook"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ChildALBWebhook", 
  "type": "object"
}

ChildAntreaTraceflowConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for AntreaTraceflowConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildAntreaTraceflowConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildAntreaTraceflowConfig"
  }, 
  "properties": {
    "TraceflowConfig": {
      "$ref": "AntreaTraceflowConfig, 
      "description": "Contains the actual AntreaTraceflowConfig object.", 
      "required": true, 
      "title": "AntreaTraceflowConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for AnteaTraceflowConfig", 
  "type": "object"
}

ChildBfdProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for BfdProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBfdProfile", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBfdProfile"
  }, 
  "properties": {
    "BfdProfile": {
      "$ref": "BfdProfile, 
      "description": "Contains the actual BfdProfile object.", 
      "required": true, 
      "title": "Bfd Profile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BfdProfile", 
  "type": "object"
}

ChildBgpNeighborConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for BgpNeighborConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBgpNeighborConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBgpNeighborConfig"
  }, 
  "properties": {
    "BgpNeighborConfig": {
      "$ref": "BgpNeighborConfig, 
      "description": "Contains the actual BgpNeighborConfig object.", 
      "required": true, 
      "title": "BgpNeighborConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BgpNeighborConfig", 
  "type": "object"
}

ChildBgpRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for BgpRoutingConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBgpRoutingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBgpRoutingConfig"
  }, 
  "properties": {
    "BgpRoutingConfig": {
      "$ref": "BgpRoutingConfig, 
      "description": "Contains the actual BgpRoutingConfig object.", 
      "required": true, 
      "title": "BgpRoutingConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BgpRoutingConfig", 
  "type": "object"
}

ChildByodPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ByodPolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildByodPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildByodPolicyServiceInstance"
  }, 
  "properties": {
    "ByodPolicyServiceInstance": {
      "$ref": "ByodPolicyServiceInstance, 
      "description": "Contains actual ByodPolicyServiceInstance.", 
      "required": true, 
      "title": "ByodPolicyServiceInstance"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ByodPolicyServiceInstance", 
  "type": "object"
}

ChildCaBundle (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCaBundle", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCaBundle"
  }, 
  "properties": {
    "CaBundle": {
      "$ref": "CaBundle, 
      "description": "Contains the actual CaBundle object.", 
      "required": true, 
      "title": "CaBundle"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Child wrapper for CA certificates bundle, used in hierarchical API.", 
  "type": "object"
}

ChildCommunicationEntry (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for CommunicationEntry, used in hierarchical API This type is deprecated. Use the type ChildRule instead.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunicationEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunicationEntry"
  }, 
  "properties": {
    "CommunicationEntry": {
      "$ref": "CommunicationEntry, 
      "description": "Contains the actual CommunicationEntry object.", 
      "required": true, 
      "title": "CommunicationEntry"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunicationEntry", 
  "type": "object"
}

ChildCommunicationMap (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for CommunicationMap, used in hierarchical API This type is deprecated. Use the type ChildSecurityPolicy instead.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunicationMap", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunicationMap"
  }, 
  "properties": {
    "CommunicationMap": {
      "$ref": "CommunicationMap, 
      "description": "Contains the actual CommunicationMap object.", 
      "required": true, 
      "title": "CommunicationMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunicationMap", 
  "type": "object"
}

ChildCommunityList (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for CommunityList, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunityList", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunityList"
  }, 
  "properties": {
    "CommunityList": {
      "$ref": "CommunityList, 
      "description": "Contains the actual CommunityList object", 
      "required": true, 
      "title": "CommunityList"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunityList", 
  "type": "object"
}

ChildComputeClusterIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildComputeClusterIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildComputeClusterIdfwConfiguration"
  }, 
  "properties": {
    "ComputeClusterIdfwConfiguration": {
      "$ref": "ComputeClusterIdfwConfiguration, 
      "description": "Contains the actual compute cluster idfw configuration object.", 
      "required": true, 
      "title": "ComputeClusterIdfwConfiguration"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ComputeClusterIdfwConfiguration", 
  "type": "object"
}

ChildConstraint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Constraint, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildConstraint", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildConstraint"
  }, 
  "properties": {
    "Constraint": {
      "$ref": "Constraint, 
      "description": "Contains the actual Constraint object", 
      "required": true, 
      "title": "Constraint"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Constraint", 
  "type": "object"
}

ChildDeploymentZone (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for DeploymentZone, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDeploymentZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDeploymentZone"
  }, 
  "properties": {
    "DeploymentZone": {
      "$ref": "DeploymentZone, 
      "description": "Contains the actual DeploymentZone object", 
      "required": true, 
      "title": "DeploymentZone"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DeploymentZone", 
  "type": "object"
}

ChildDfwFirewallConfiguration (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDfwFirewallConfiguration", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDfwFirewallConfiguration"
  }, 
  "properties": {
    "DfwFirewallConfiguration": {
      "$ref": "DfwFirewallConfiguration, 
      "description": "Contains the actual dfw firewall configuration list object.", 
      "required": true, 
      "title": "Dfw Firewall Configuration"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FirewallConfiguration", 
  "type": "object"
}

ChildDhcpRelayConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DhcpRelayConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpRelayConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpRelayConfig"
  }, 
  "properties": {
    "DhcpRelayConfig": {
      "$ref": "DhcpRelayConfig, 
      "description": "Contains the actual DhcpRelayConfig object", 
      "required": true, 
      "title": "DhcpRelayConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpRelayConfig", 
  "type": "object"
}

ChildDhcpServerConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DhcpServerConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpServerConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpServerConfig"
  }, 
  "properties": {
    "DhcpServerConfig": {
      "$ref": "DhcpServerConfig, 
      "description": "Contains the actual DhcpServerConfig object", 
      "required": true, 
      "title": "DhcpServerConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpServerConfig", 
  "type": "object"
}

ChildDhcpStaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for DhcpStaticBindingConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpStaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpStaticBindingConfig"
  }, 
  "properties": {
    "DhcpStaticBindingConfig": {
      "$ref": "DhcpStaticBindingConfig, 
      "description": "Contains the actual DhcpStaticBindingConfig object.", 
      "required": true, 
      "title": "DhcpStaticBindingConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpStaticBindingConfig", 
  "type": "object"
}

ChildDnsSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DnsSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDnsSecurityProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "DnsSecurityProfile": {
      "$ref": "DnsSecurityProfile, 
      "description": "Contains the actual DnsSecurityProfile object", 
      "required": true, 
      "title": "DnsSecurityProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DnsSecurityProfile", 
  "type": "object"
}

ChildDnsSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper obejct for DnsSecurityProfileBindingMap used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDnsSecurityProfileBindingMap", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "DnsSecurityProfileBindingMap": {
      "$ref": "DnsSecurityProfileBindingMap, 
      "description": "Contains the actual DnsSecurityProfileBindingMap object", 
      "required": true, 
      "title": "DnsSecurityProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DnsSecurityProfileBindingMap", 
  "type": "object"
}

ChildDomain (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for domain, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDomain", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDomain"
  }, 
  "properties": {
    "Domain": {
      "$ref": "Domain, 
      "description": "Contains the actual domain object.", 
      "required": true, 
      "title": "Domain"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Domain", 
  "type": "object"
}

ChildDomainDeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DomainDeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDomainDeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDomainDeploymentMap"
  }, 
  "properties": {
    "DomainDeploymentMap": {
      "$ref": "DomainDeploymentMap, 
      "description": "Contains the actual DomainDeploymentMap object.", 
      "required": true, 
      "title": "DomainDeploymentMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DomainDeploymentMap", 
  "type": "object"
}

ChildEndpointPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EndpointPolicy used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEndpointPolicy", 
  "module_id": "PolicyGuestIntrospection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEndpointPolicy"
  }, 
  "properties": {
    "EndpointPolicy": {
      "$ref": "EndpointPolicy, 
      "description": "Contains actual EndpointPolicy.", 
      "required": true, 
      "title": "EndpointPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Endpoint Policy", 
  "type": "object"
}

ChildEndpointRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EndpointRule used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEndpointRule", 
  "module_id": "PolicyGuestIntrospection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEndpointRule"
  }, 
  "properties": {
    "EndpointRule": {
      "$ref": "EndpointRule, 
      "description": "Contains actual EndpointRule.", 
      "required": true, 
      "title": "EndpointRule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Endpoint Rule", 
  "type": "object"
}

ChildEnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EnforcementPoint, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEnforcementPoint", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEnforcementPoint"
  }, 
  "properties": {
    "EnforcementPoint": {
      "$ref": "EnforcementPoint, 
      "description": "Contains the actual Enforcement point object.", 
      "required": true, 
      "title": "EnforcementPoint"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EnforcementPoint", 
  "type": "object"
}

ChildEvpnConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EvpnConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEvpnConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEvpnConfig"
  }, 
  "properties": {
    "EvpnConfig": {
      "$ref": "EvpnConfig, 
      "description": "Contains the actual EvpnConfig object.", 
      "required": true, 
      "title": "EvpnConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EvpnConfig", 
  "type": "object"
}

ChildEvpnTunnelEndpointConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EvpnTunnelEndpointConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEvpnTunnelEndpointConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEvpnTunnelEndpointConfig"
  }, 
  "properties": {
    "EvpnTunnelEndpointConfig": {
      "$ref": "EvpnTunnelEndpointConfig, 
      "description": "Contains the actual EvpnTunnelEndpointConfig object.", 
      "required": true, 
      "title": "EvpnTunnelEndpointConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EvpnTunnelEndpointConfig", 
  "type": "object"
}

ChildFloodProtectionProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FloodProtectionProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFloodProtectionProfile"
  }, 
  "properties": {
    "FloodProtectionProfile": {
      "$ref": "FloodProtectionProfile, 
      "description": "Contains the actual FloodProtectionProfile object", 
      "required": true, 
      "title": "FloodProtectionProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FloodProtectionProfile", 
  "type": "object"
}

ChildFloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FloodProtectionProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFloodProtectionProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFloodProtectionProfileBindingMap"
  }, 
  "properties": {
    "FloodProtectionProfileBindingMap": {
      "$ref": "FloodProtectionProfileBindingMap, 
      "description": "Contains the actual FloodProtectionProfileBindingMap object", 
      "required": true, 
      "title": "FloodProtectionProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FloodProtectionProfileBindingMap", 
  "type": "object"
}

ChildForwardingPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ForwardingPolicy used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildForwardingPolicy", 
  "module_id": "PolicyForwarding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildForwardingPolicy"
  }, 
  "properties": {
    "ForwardingPolicy": {
      "$ref": "ForwardingPolicy, 
      "description": "Contains actual ForwardingPolicy.", 
      "required": true, 
      "title": "ForwardingPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for children of type ForwardingPolicy\n", 
  "type": "object"
}

ChildForwardingRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ForwardingRule used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildForwardingRule", 
  "module_id": "PolicyForwarding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildForwardingRule"
  }, 
  "properties": {
    "ForwardingRule": {
      "$ref": "ForwardingRule, 
      "description": "Contains actual ForwardingRule.", 
      "required": true, 
      "title": "ForwardingRule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ForwardingRule\n", 
  "type": "object"
}

ChildFqdnAnalysisConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FqdnAnalysisConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFqdnAnalysisConfig", 
  "module_id": "PolicyUrlCategorization", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFqdnAnalysisConfig"
  }, 
  "properties": {
    "FqdnAnalysisConfig": {
      "$ref": "FqdnAnalysisConfig, 
      "description": "Contains the actual FqdnAnalysisConfig object", 
      "required": true, 
      "title": "FQDN Analysis Config"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FqdnAnalysisConfig", 
  "type": "object"
}

ChildGatewayPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GatewayPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGatewayPolicy", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGatewayPolicy"
  }, 
  "properties": {
    "GatewayPolicy": {
      "$ref": "GatewayPolicy, 
      "description": "Contains the actual GatewayPolicy object", 
      "required": true, 
      "title": "GatewayPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GatewayPolicy", 
  "type": "object"
}

ChildGatewayQosProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for GatewayQosProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGatewayQosProfile", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGatewayQosProfile"
  }, 
  "properties": {
    "QosProfile": {
      "$ref": "GatewayQosProfile, 
      "description": "Contains the actual GatewayQosProfile object.", 
      "required": true, 
      "title": "GatewayQosProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GatewayQosProfile", 
  "type": "object"
}

ChildGeneralSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GeneralSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGeneralSecurityProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGeneralSecurityProfile"
  }, 
  "properties": {
    "GeneralSecurityProfile": {
      "$ref": "GeneralSecurityProfile, 
      "description": "Contains the actual GeneralSecurityProfile object", 
      "required": true, 
      "title": "GeneralSecurityProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GeneralSecurityProfile", 
  "type": "object"
}

ChildGeneralSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GeneralSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGeneralSecurityProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGeneralSecurityProfileBindingMap"
  }, 
  "properties": {
    "GeneralSecurityProfileBindingMap": {
      "$ref": "GeneralSecurityProfileBindingMap, 
      "description": "Contains the actual GeneralSecurityProfileBindingMap object", 
      "required": true, 
      "title": "GeneralSecurityProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GeneralSecurityProfileBindingMap", 
  "type": "object"
}

ChildGlobalConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GlobalConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalConfig", 
  "module_id": "Policy", 
  "properties": {
    "GlobalConfig": {
      "$ref": "GlobalConfig, 
      "description": "Contains the actual GlobalConfig object.", 
      "required": true, 
      "title": "GlobalConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalConfig", 
  "type": "object"
}

ChildGlobalDfwConfiguration (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalDfwConfiguration", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalDfwConfiguration"
  }, 
  "properties": {
    "GlobalDfwConfiguration": {
      "$ref": "GlobalDfwConfiguration, 
      "description": "Contains the actual global distributed firewall configuration object.", 
      "required": true, 
      "title": "Global distributed firewall configuration"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalDfwConfiguration", 
  "type": "object"
}

ChildGlobalIdsSettings (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GlobalIdsSettings, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalIdsSettings", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalIdsSettings"
  }, 
  "properties": {
    "GlobalIdsSettings": {
      "$ref": "GlobalIdsSettings, 
      "description": "Contains the GlobalIdsSettings object", 
      "required": true, 
      "title": "GlobalIdsSettings"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalIdsSettings", 
  "type": "object"
}

ChildGlobalIdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GlobalIdsSignature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalIdsSignature", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalIdsSignature"
  }, 
  "properties": {
    "GlobalIdsSignature": {
      "$ref": "GlobalIdsSignature, 
      "description": "Contains the GlobalIdsSignature object", 
      "required": true, 
      "title": "GlobalIdsSignature"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalIdsSignature", 
  "type": "object"
}

ChildGlobalManager (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Global Manager, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalManager", 
  "module_id": "PolicySiteGM", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalManager"
  }, 
  "properties": {
    "GlobalManager": {
      "$ref": "GlobalManager, 
      "description": "Contains the actual Global Manager object.", 
      "required": true, 
      "title": "GlobalManager"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Global Manager", 
  "type": "object"
}

ChildGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for group, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroup", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGroup"
  }, 
  "properties": {
    "Group": {
      "$ref": "Group, 
      "description": "Contains the actual group objects.", 
      "required": true, 
      "title": "Group"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Group", 
  "type": "object"
}

ChildGroupDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper obejct for GroupDiscoveryProfileBindingMap used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroupDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "GroupDiscoveryProfileBindingMap": {
      "$ref": "GroupDiscoveryProfileBindingMap, 
      "description": "Contains the actual GroupDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "GroupDiscoveryProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GroupDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildGroupMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GroupMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroupMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGroupMonitoringProfileBindingMap"
  }, 
  "properties": {
    "GroupMonitoringProfileBindingMap": {
      "$ref": "GroupMonitoringProfileBindingMap, 
      "description": "Contains the actual GroupMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "GroupMonitoringProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GroupMonitoringProfileBindingMap", 
  "type": "object"
}

ChildHostTransportNode (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for Host Transport Node, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildHostTransportNode", 
  "module_id": "PolicyHostTransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildHostTransportNode"
  }, 
  "properties": {
    "HostTransportNode": {
      "$ref": "HostTransportNode, 
      "description": "Contains the actual Host Transport Node object.", 
      "required": true, 
      "title": "Host Transport Node"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Host Transport Node", 
  "type": "object"
}

ChildHostTransportNodeCollection (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for Transport Collection, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildHostTransportNodeCollection", 
  "module_id": "HostTransportNodeCollection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildHostTransportNodeCollection"
  }, 
  "properties": {
    "HostTransportNodeCollection": {
      "$ref": "HostTransportNodeCollection, 
      "description": "Contains the actual Transport Node Collection object.", 
      "required": true, 
      "title": "Transport Node Collection"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Transport Node Collection", 
  "type": "object"
}

ChildIPDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPDiscoveryProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPDiscoveryProfile", 
  "module_id": "PolicyIpDiscovery", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPDiscoveryProfile"
  }, 
  "properties": {
    "IPDiscoveryProfile": {
      "$ref": "IPDiscoveryProfile, 
      "description": "Contains the actual IPDiscoveryProfile object", 
      "required": true, 
      "title": "IPDiscoveryProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPDiscoveryProfile", 
  "type": "object"
}

ChildIPFIXDFWCollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXDFWCollectorProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXDFWCollectorProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXDFWCollectorProfile"
  }, 
  "properties": {
    "IPFIXDFWCollectorProfile": {
      "$ref": "IPFIXDFWCollectorProfile, 
      "description": "Contains the actual IPFIXDFWCollectorProfile object", 
      "required": true, 
      "title": "IPFIXDFWCollectorProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXDFWCollectorProfile", 
  "type": "object"
}

ChildIPFIXDFWProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXDFWProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXDFWProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXDFWProfile"
  }, 
  "properties": {
    "IPFIXDFWProfile": {
      "$ref": "IPFIXDFWProfile, 
      "description": "Contains the actual IPFIXDFWProfile object", 
      "required": true, 
      "title": "IPFIXDFWProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXDFWProfile", 
  "type": "object"
}

ChildIPFIXL2CollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXL2CollectorProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXL2CollectorProfile", 
  "module_id": "PolicyIPFIXSwitch", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXL2CollectorProfile"
  }, 
  "properties": {
    "IPFIXL2CollectorProfile": {
      "$ref": "IPFIXL2CollectorProfile, 
      "description": "Contains the actual IPFIXL2CollectorProfile object", 
      "required": true, 
      "title": "IPFIXL2CollectorProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXL2CollectorProfile", 
  "type": "object"
}

ChildIPFIXL2Profile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXL2Profile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXL2Profile", 
  "module_id": "PolicyIPFIXSwitch", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXL2Profile"
  }, 
  "properties": {
    "IPFIXL2Profile": {
      "$ref": "IPFIXL2Profile, 
      "description": "Contains the actual IPFIXL2Profile object", 
      "required": true, 
      "title": "IPFIXL2Profile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXL2Profile", 
  "type": "object"
}

ChildIPSecVpnDpdProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnDpdProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnDpdProfile", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnDpdProfile"
  }, 
  "properties": {
    "IPSecVpnDpdProfile": {
      "$ref": "IPSecVpnDpdProfile, 
      "description": "Contains the actual IPSecVpnDpdProfile object.", 
      "required": true, 
      "title": "IPSecVpnDpdProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnDpdProfile", 
  "type": "object"
}

ChildIPSecVpnIkeProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnIkeProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnIkeProfile", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnIkeProfile"
  }, 
  "properties": {
    "IPSecVpnIkeProfile": {
      "$ref": "IPSecVpnIkeProfile, 
      "description": "Contains the actual IPSecVpnIkeProfile object.", 
      "required": true, 
      "title": "IPSecVpnIkeProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnIkeProfile", 
  "type": "object"
}

ChildIPSecVpnLocalEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnLocalEndpoint, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnLocalEndpoint", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnLocalEndpoint"
  }, 
  "properties": {
    "IPSecVpnLocalEndpoint": {
      "$ref": "IPSecVpnLocalEndpoint, 
      "description": "Contains the actual IPSecVpnLocalEndpoint object.", 
      "required": true, 
      "title": "IPSecVpnLocalEndpoint"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnLocalEndpoint", 
  "type": "object"
}

ChildIPSecVpnService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnService", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnService"
  }, 
  "properties": {
    "IPSecVpnService": {
      "$ref": "IPSecVpnService, 
      "description": "Contains the actual IPSecVpnService object.", 
      "required": true, 
      "title": "IPSecVpnService"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnService", 
  "type": "object"
}

ChildIPSecVpnSession (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnSession, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnSession", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnSession"
  }, 
  "properties": {
    "IPSecVpnSession": {
      "$ref": "IPSecVpnSession, 
      "description": "Contains the actual IPSecVpnSession object.", 
      "required": true, 
      "title": "IPSecVpnSession"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnSession", 
  "type": "object"
}

ChildIPSecVpnTunnelProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnTunnelProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnTunnelProfile", 
  "module_id": "PolicyVpnIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnTunnelProfile"
  }, 
  "properties": {
    "IPSecVpnTunnelProfile": {
      "$ref": "IPSecVpnTunnelProfile, 
      "description": "Contains the actual IPSecVpnTunnelProfile object", 
      "required": true, 
      "title": "IPSecVpnTunnelProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnTunnelProfile", 
  "type": "object"
}

ChildIdentityFirewallStore (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for IdentityFirewallStore, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdentityFirewallStore", 
  "module_id": "PolicyIdentity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdentityFirewallStore"
  }, 
  "properties": {
    "IdentityFirewallStore": {
      "$ref": "IdentityFirewallStore, 
      "description": "Contains the actual IdentityFirewallStore object.", 
      "required": true, 
      "title": "IdentityFirewallStore"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdentityFirewallStore", 
  "type": "object"
}

ChildIdsClusterConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsClusterConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsClusterConfig", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsClusterConfig"
  }, 
  "properties": {
    "IdsClusterConfig": {
      "$ref": "IdsClusterConfig, 
      "description": "Contains the IdsClusterConfig object", 
      "required": true, 
      "title": "IdsClusterConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsClusterConfig", 
  "type": "object"
}

ChildIdsGatewayPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsGatewayPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsGatewayPolicy", 
  "module_id": "PolicyIDSGateway", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsGatewayPolicy"
  }, 
  "properties": {
    "IdsGatewayPolicy": {
      "$ref": "IdsGatewayPolicy, 
      "description": "Contains the IdsGatewayPolicy object", 
      "required": true, 
      "title": "IdsGatewayPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsGatewayPolicy", 
  "type": "object"
}

ChildIdsGlobalEventConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsGlobalEventConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsGlobalEventConfig", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsGlobalEventConfig"
  }, 
  "properties": {
    "IdsGlobalEventConfig": {
      "$ref": "IdsGlobalEventConfig, 
      "description": "Contains the IdsGlobalEventConfig object", 
      "required": true, 
      "title": "IdsGlobalEventConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsGlobalEventConfig", 
  "type": "object"
}

ChildIdsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsProfile", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsProfile"
  }, 
  "properties": {
    "IdsProfile": {
      "$ref": "IdsProfile, 
      "description": "Contains the IdsProfile object", 
      "required": true, 
      "title": "IdsProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsProfile", 
  "type": "object"
}

ChildIdsRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsRule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsRule", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsRule"
  }, 
  "properties": {
    "IdsRule": {
      "$ref": "IdsRule, 
      "description": "Contains the IdsRule object", 
      "required": true, 
      "title": "IdsRule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsRule", 
  "type": "object"
}

ChildIdsSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSecurityPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSecurityPolicy", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSecurityPolicy"
  }, 
  "properties": {
    "IdsSecurityPolicy": {
      "$ref": "IdsSecurityPolicy, 
      "description": "Contains the IdsSecurityPolicy object", 
      "required": true, 
      "title": "IdsSecurityPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSecurityPolicy", 
  "type": "object"
}

ChildIdsSettings (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSettings, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSettings", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSettings"
  }, 
  "properties": {
    "IdsSettings": {
      "$ref": "IdsSettings, 
      "description": "Contains the IdsSettings object", 
      "required": true, 
      "title": "IdsSettings"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSettings", 
  "type": "object"
}

ChildIdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSignature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSignature", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSignature"
  }, 
  "properties": {
    "IdsSignature": {
      "$ref": "IdsSignature, 
      "description": "Contains the IdsSignature object", 
      "required": true, 
      "title": "IdsSignature"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSignature", 
  "type": "object"
}

ChildIdsSignatureStatus (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSignatureStatus, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSignatureStatus", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSignatureStatus"
  }, 
  "properties": {
    "IdsSignatureStatus": {
      "$ref": "IdsSignatureStatus, 
      "description": "Contains the IdsSignatureStatus object", 
      "required": true, 
      "title": "IdsSignatureStatus"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSignatureStatus", 
  "type": "object"
}

ChildIdsSignatureVersion (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSignatureVersion, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSignatureVersion", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSignatureVersion"
  }, 
  "properties": {
    "IdsSignatureVersion": {
      "$ref": "IdsSignatureVersion, 
      "description": "Contains the IdsSignatureVersion object", 
      "required": true, 
      "title": "IdsSignatureVersion"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSignatureVersion", 
  "type": "object"
}

ChildIdsStandaloneHostConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsStandaloneHostConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsStandaloneHostConfig", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsStandaloneHostConfig"
  }, 
  "properties": {
    "IdsStandaloneHostConfig": {
      "$ref": "IdsStandaloneHostConfig, 
      "description": "Contains the IdsStandaloneHostConfig object", 
      "required": true, 
      "title": "IdsStandaloneHostConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsStandaloneHostConfig", 
  "type": "object"
}

ChildInfra (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Infra, used in multi-tenancy hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildInfra", 
  "module_id": "Policy", 
  "properties": {
    "Infra": {
      "$ref": "Infra, 
      "description": "Contains the actual Infra object", 
      "required": true, 
      "title": "Infra"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Infra", 
  "type": "object"
}

ChildIpAddressAllocation (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressAllocation, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressAllocation", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressAllocation"
  }, 
  "properties": {
    "IpAddressAllocation": {
      "$ref": "IpAddressAllocation, 
      "description": "Contains the actual IpAddressAllocation object", 
      "required": true, 
      "title": "IpAddressAllocation"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressAllocation", 
  "type": "object"
}

ChildIpAddressBlock (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressBlock, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressBlock", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressBlock"
  }, 
  "properties": {
    "IpAddressBlock": {
      "$ref": "IpAddressBlock, 
      "description": "Contains the actual IpAddressBlock object", 
      "required": true, 
      "title": "IpAddressBlock"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressBlock", 
  "type": "object"
}

ChildIpAddressPool (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressPool, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressPool", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressPool"
  }, 
  "properties": {
    "IpAddressPool": {
      "$ref": "IpAddressPool, 
      "description": "Contains the actual IpAddressPool object", 
      "required": true, 
      "title": "IpAddressPool"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressPool", 
  "type": "object"
}

ChildIpAddressPoolSubnet (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressPoolSubnet, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressPoolSubnet", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressPoolSubnet"
  }, 
  "properties": {
    "IpAddressPoolSubnet": {
      "$ref": "IpAddressPoolSubnet, 
      "description": "Contains the actual IpAddressPoolSubnet object", 
      "required": true, 
      "title": "IpAddressPoolSubnet"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressPoolSubnet", 
  "type": "object"
}

ChildIpv6DadProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Ipv6DadProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpv6DadProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "Ipv6DadProfile": {
      "$ref": "Ipv6DadProfile, 
      "description": "Contains the actual Ipv6DadProfile objects", 
      "required": true, 
      "title": "Ipv6DadProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Ipv6DadProfile", 
  "type": "object"
}

ChildIpv6NdraProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Ipv6NdraProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpv6NdraProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "Ipv6NdraProfile": {
      "$ref": "Ipv6NdraProfile, 
      "description": "Contains the actual Ipv6NdraProfile objects", 
      "required": true, 
      "title": "Ipv6NdraProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Ipv6NdraProfile", 
  "type": "object"
}

ChildL2BridgeEndpointProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2BridgeEndpointProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2BridgeEndpointProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "L2BridgeEndpointProfile": {
      "$ref": "L2BridgeEndpointProfile, 
      "description": "Contains the actual L2BridgeEndpointProfile object", 
      "required": true, 
      "title": "L2BridgeEndpointProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2BridgeEndpointProfile", 
  "type": "object"
}

ChildL2VPNService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2VPNService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VPNService", 
  "module_id": "PolicyVpnLayer2VPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VPNService"
  }, 
  "properties": {
    "L2VPNService": {
      "$ref": "L2VPNService, 
      "description": "Contains the actual L2VPNService object.", 
      "required": true, 
      "title": "L2VPNService"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VPNService", 
  "type": "object"
}

ChildL2VPNSession (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2VPNSession, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VPNSession", 
  "module_id": "PolicyVpnLayer2VPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VPNSession"
  }, 
  "properties": {
    "L2VPNSession": {
      "$ref": "L2VPNSession, 
      "description": "Contains the actual L2VPNSession object.", 
      "required": true, 
      "title": "L2VPNSession"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VPNSession", 
  "type": "object"
}

ChildL2Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L2Vpn, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2Vpn", 
  "module_id": "PolicyL2Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2Vpn"
  }, 
  "properties": {
    "L2Vpn": {
      "$ref": "L2Vpn, 
      "description": "Contains the actual L2Vpn object.", 
      "required": true, 
      "title": "L2Vpn"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2Vpn", 
  "type": "object"
}

ChildL2VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L2VpnContext, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VpnContext", 
  "module_id": "PolicyL2Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VpnContext"
  }, 
  "properties": {
    "L2VpnContext": {
      "$ref": "L2VpnContext, 
      "description": "Contains the actual L2VpnContext object.", 
      "required": true, 
      "title": "L2VpnContext"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VpnContext", 
  "type": "object"
}

ChildL3Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L3Vpn, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL3Vpn", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL3Vpn"
  }, 
  "properties": {
    "L3Vpn": {
      "$ref": "L3Vpn, 
      "description": "Contains the actual L3Vpn object.", 
      "required": true, 
      "title": "L3Vpn"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L3Vpn", 
  "type": "object"
}

ChildL3VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L3VpnContext, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL3VpnContext", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL3VpnContext"
  }, 
  "properties": {
    "L3VpnContext": {
      "$ref": "L3VpnContext, 
      "description": "Contains the actual L3VpnContext object.", 
      "required": true, 
      "title": "L3VpnContext"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L3VpnContext", 
  "type": "object"
}

ChildL7AccessEntry (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L7 Access Entry, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL7AccessEntry", 
  "module_id": "L7AccessProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL7AccessEntry"
  }, 
  "properties": {
    "L7AccessEntry": {
      "$ref": "L7AccessEntry, 
      "description": "Contains the actual L7 access entry object", 
      "required": true, 
      "title": "L7 Access Entry"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L7 Access Entry", 
  "type": "object"
}

ChildL7AccessProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L7 Access Profile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL7AccessProfile", 
  "module_id": "L7AccessProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL7AccessProfile"
  }, 
  "properties": {
    "L7AccessProfile": {
      "$ref": "L7AccessProfile, 
      "description": "Contains the actual L7 access profile object", 
      "required": true, 
      "title": "L7 access profile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L7 Access Profile", 
  "type": "object"
}

ChildLBAppProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBAppProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBAppProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBAppProfile"
  }, 
  "properties": {
    "LBAppProfile": {
      "$ref": "LBAppProfile, 
      "description": "Contains the actual LBAppProfile object.", 
      "required": true, 
      "title": "LBAppProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBAppProfile", 
  "type": "object"
}

ChildLBClientSslProfile (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper for LBClientSslProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBClientSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBClientSslProfile"
  }, 
  "properties": {
    "LBClientSslProfile": {
      "$ref": "LBClientSslProfile, 
      "description": "Contains the actual LBClientSslProfile object.", 
      "required": true, 
      "title": "LBClientSslProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBClientSslProfile", 
  "type": "object"
}

ChildLBMonitorProfile (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper for LBMonitorProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBMonitorProfile"
  }, 
  "properties": {
    "LBMonitorProfile": {
      "$ref": "LBMonitorProfile, 
      "description": "Contains the actual LBMonitorProfile object.", 
      "required": true, 
      "title": "LBMonitorProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBMonitorProfile", 
  "type": "object"
}

ChildLBPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBPersistenceProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBPersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBPersistenceProfile"
  }, 
  "properties": {
    "LBPersistenceProfile": {
      "$ref": "LBPersistenceProfile, 
      "description": "Contains the actual LBPersistenceProfile object.", 
      "required": true, 
      "title": "LBPersistenceProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBPersistenceProfile", 
  "type": "object"
}

ChildLBPool (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBPool, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBPool", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBPool"
  }, 
  "properties": {
    "LBPool": {
      "$ref": "LBPool, 
      "description": "Contains the actual LBPool object.", 
      "required": true, 
      "title": "LBPool"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBPool", 
  "type": "object"
}

ChildLBServerSslProfile (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper for LBServerSslProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBServerSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBServerSslProfile"
  }, 
  "properties": {
    "LBServerSslProfile": {
      "$ref": "LBServerSslProfile, 
      "description": "Contains the actual LBServerSslProfile object.", 
      "required": true, 
      "title": "LBServerSslProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBServerSslProfile", 
  "type": "object"
}

ChildLBService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBService", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBService"
  }, 
  "properties": {
    "LBService": {
      "$ref": "LBService, 
      "description": "Contains the actual LBService object.", 
      "required": true, 
      "title": "LBService"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBService", 
  "type": "object"
}

ChildLBVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBVirtualServer, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBVirtualServer", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBVirtualServer"
  }, 
  "properties": {
    "LBVirtualServer": {
      "$ref": "LBVirtualServer, 
      "description": "Contains the actual LBVirtualServer object.", 
      "required": true, 
      "title": "LBVirtualServer"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBVirtualServer", 
  "type": "object"
}

ChildLiveTraceConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LiveTraceConfig for Hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLiveTraceConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLiveTraceConfig"
  }, 
  "properties": {
    "LiveTraceConfig": {
      "$ref": "LiveTraceConfig, 
      "description": "The actual LiveTraceConfig object.", 
      "required": true, 
      "title": "LiveTraceConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LiveTraceConfig", 
  "type": "object"
}

ChildLocaleServices (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for LocaleServices, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLocaleServices", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLocaleServices"
  }, 
  "properties": {
    "LocaleServices": {
      "$ref": "LocaleServices, 
      "description": "Contains the actual LocaleServices object", 
      "required": true, 
      "title": "LocaleServices"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LocaleServices", 
  "type": "object"
}

ChildMacDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for MacDiscoveryProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMacDiscoveryProfile", 
  "module_id": "PolicyMacDiscovery", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMacDiscoveryProfile"
  }, 
  "properties": {
    "MacDiscoveryProfile": {
      "$ref": "MacDiscoveryProfile, 
      "description": "Contains the actual MacDiscoveryProfile object", 
      "required": true, 
      "title": "MacDiscoveryProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MacDiscoveryProfile", 
  "type": "object"
}

ChildMalwarePreventionProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for MalwarePreventionProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMalwarePreventionProfile", 
  "module_id": "PolicyAntiMalware", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMalwarePreventionProfile"
  }, 
  "properties": {
    "MalwarePreventionProfile": {
      "$ref": "MalwarePreventionProfile, 
      "description": "Contains the MalwarePreventionProfile object", 
      "required": true, 
      "title": "MalwarePreventionProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MalwarePreventionProfile", 
  "type": "object"
}

ChildMalwarePreventionSignature (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for MalwarePreventionSignature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMalwarePreventionSignature", 
  "module_id": "PolicyAntiMalware", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMalwarePreventionSignature"
  }, 
  "properties": {
    "MalwarePreventionSignature": {
      "$ref": "MalwarePreventionSignature, 
      "description": "Contains the MalwarePreventionSignature object", 
      "required": true, 
      "title": "MalwarePreventionSignature"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MalwarePreventionSignature", 
  "type": "object"
}

ChildMetadataProxyConfig (type)

{
  "additionalProperties": false, 
  "descritpion": "Child wrapper object for MetadataProxyConfig, used in hierarchical APIs", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMetadataProxyConfig", 
  "module_id": "PolicyMetadataProxy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMetadataProxyConfig"
  }, 
  "properties": {
    "MetadataProxyConfig": {
      "$ref": "MetadataProxyConfig, 
      "description": "Contains the actual MetadataProxyConfig object.", 
      "required": true, 
      "title": "MetadataProxyConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MetadataProxyConfig", 
  "type": "object"
}

ChildOdsRunbookInvocation (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for OdsRunbookInvocation for Hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOdsRunbookInvocation", 
  "module_id": "PolicyOds", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildOdsRunbookInvocation"
  }, 
  "properties": {
    "OdsRunbookInvocation": {
      "$ref": "OdsRunbookInvocation, 
      "description": "The actual OdsRunbookInvocation object.", 
      "required": true, 
      "title": "OdsRunbookInvocation"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OdsRunbookInvocation", 
  "type": "object"
}

ChildOdsRunbookInvocationArtifactBatchRequest (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for OdsRunbookInvocationArtifactBatchRequest for Hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOdsRunbookInvocationArtifactBatchRequest", 
  "module_id": "PolicyOds", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildOdsRunbookInvocationArtifactBatchRequest"
  }, 
  "properties": {
    "OdsRunbookInvocation": {
      "$ref": "OdsRunbookInvocationArtifactBatchRequest, 
      "description": "The actual OdsRunbookInvocationArtifactBatchRequest object.", 
      "required": true, 
      "title": "OdsRunbookInvocationArtifactBatchRequest"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OdsRunbookInvocationArtifactBatchRequest", 
  "type": "object"
}

ChildOpsGlobalConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for OpsGlobalConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOpsGlobalConfig", 
  "module_id": "Policy", 
  "properties": {
    "GlobalConfig": {
      "$ref": "OpsGlobalConfig, 
      "description": "Contains the actual OpsGlobalConfig object.", 
      "required": true, 
      "title": "OpsGlobalConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OpsGlobalConfig", 
  "type": "object"
}

ChildOrg (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Org, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOrg", 
  "module_id": "PolicyOrg", 
  "properties": {
    "Org": {
      "$ref": "Org, 
      "description": "Contains the actual Org object", 
      "required": true, 
      "title": "Org"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Org", 
  "type": "object"
}

ChildOrgRoot (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for OrgRoot, used in multi-tenancy hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOrgRoot", 
  "module_id": "PolicyOrgRoot", 
  "properties": {
    "OrgRoot": {
      "$ref": "OrgRoot, 
      "description": "Contains the actual OrgRoot object", 
      "required": true, 
      "title": "OrgRoot"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OrgRoot", 
  "type": "object"
}

ChildOspfAreaConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for OspfAreaConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOspfAreaConfig", 
  "module_id": "PolicyOspf", 
  "properties": {
    "OspfAreaConfig": {
      "$ref": "OspfAreaConfig, 
      "description": "Contains actual OspfAreaConfig.", 
      "required": true, 
      "title": "OspfAreaConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OSPF routing config", 
  "type": "object"
}

ChildOspfRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for OspfRoutingConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildOspfRoutingConfig", 
  "module_id": "PolicyOspf", 
  "properties": {
    "OspfRoutingConfig": {
      "$ref": "OspfRoutingConfig, 
      "description": "Contains actual OspfRoutingConfig.", 
      "required": true, 
      "title": "OspfRoutingConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for OSPF routing config", 
  "type": "object"
}

ChildPolicyConfigResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an object on the desired state", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ChildPolicyConfigResource", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the desired state object as child resource", 
  "type": "object"
}

ChildPolicyContextProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyContextProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyContextProfile", 
  "module_id": "PolicyContextProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyContextProfile"
  }, 
  "properties": {
    "PolicyContextProfile": {
      "$ref": "PolicyContextProfile, 
      "description": "Contains the actual PolicyContextProfile objects", 
      "required": true, 
      "title": "PolicyContextProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyContextProfile", 
  "type": "object"
}

ChildPolicyCustomAttributes (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyCustomAttributes, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyCustomAttributes", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "PolicyCustomAttributes": {
      "$ref": "PolicyCustomAttributes, 
      "description": "Contains the actual PolicyCustomAttributes objects", 
      "required": true, 
      "title": "PolicyCustomAttributes"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyCustomAttributes", 
  "type": "object"
}

ChildPolicyDnsForwarder (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyDnsForwarder, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyDnsForwarder", 
  "module_id": "PolicyDnsForwarder", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyDnsForwarder"
  }, 
  "properties": {
    "PolicyDnsForwarder": {
      "$ref": "PolicyDnsForwarder, 
      "description": "Contains the actual PolicyDnsForwarder object", 
      "required": true, 
      "title": "PolicyDnsForwarder"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyDnsForwarder", 
  "type": "object"
}

ChildPolicyDnsForwarderZone (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyDnsForwarderZone, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyDnsForwarderZone", 
  "module_id": "PolicyDnsForwarder", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyDnsForwarderZone"
  }, 
  "properties": {
    "PolicyDnsForwarderZone": {
      "$ref": "PolicyDnsForwarderZone, 
      "description": "Contains the actual PolicyDnsForwarderZone object", 
      "required": true, 
      "title": "PolicyDnsForwarderZone"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyDnsForwarderZone", 
  "type": "object"
}

ChildPolicyEdgeCluster (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyEdgeCluster, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyEdgeCluster", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyEdgeCluster"
  }, 
  "properties": {
    "PolicyEdgeCluster": {
      "$ref": "PolicyEdgeCluster, 
      "description": "Contains the actual PolicyEdgeCluster object.", 
      "required": true, 
      "title": "PolicyEdgeCluster"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyEdgeCluster", 
  "type": "object"
}

ChildPolicyEdgeNode (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyEdgeNode, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyEdgeNode", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyEdgeNode"
  }, 
  "properties": {
    "PolicyEdgeNode": {
      "$ref": "PolicyEdgeNode, 
      "description": "Contains the actual PolicyEdgeNode object.", 
      "required": true, 
      "title": "PolicyEdgeNode"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyEdgeNode", 
  "type": "object"
}

ChildPolicyExcludeList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyExcludeList", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyExcludeList"
  }, 
  "properties": {
    "PolicyExcludeList": {
      "$ref": "PolicyExcludeList, 
      "description": "Contains the actual policy exclude list object.", 
      "required": true, 
      "title": "PolicyExcludeList"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyExcludeList", 
  "type": "object"
}

ChildPolicyFirewallCPUMemThresholdsProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallCPUMemThresholdsProfileBindingMap", 
  "module_id": "PolicyFirewallCPUMemThresholdsProfileBinding", 
  "properties": {
    "PolicyFirewallCPUMemThresholdsProfileBindingMap": {
      "$ref": "PolicyFirewallCPUMemThresholdsProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallCPUMemThresholdsProfileBindingMap object.", 
      "required": true, 
      "title": "PolicyFirewallCPUMemThresholdsProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap", 
  "type": "object"
}

ChildPolicyFirewallCpuMemThresholdsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallCpuMemThresholdsProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallCpuMemThresholdsProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "PolicyFirewallCpuMemThresholdsProfile": {
      "$ref": "PolicyFirewallCpuMemThresholdsProfile, 
      "description": "Contains the actual PolicyFirewallCpuMemThresholdsProfile object", 
      "required": true, 
      "title": "PolicyFirewallCpuMemThresholdsProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallCpuMemThresholdsProfile", 
  "type": "object"
}

ChildPolicyFirewallFloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallFloodProtectionProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallFloodProtectionProfileBindingMap", 
  "module_id": "PolicyFirewallFloodProtectionProfileBinding", 
  "properties": {
    "PolicyFirewallFloodProtectionProfileBindingMap": {
      "$ref": "PolicyFirewallFloodProtectionProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallFloodProtectionProfileBindingMap object", 
      "required": true, 
      "title": "PolicyFirewallFloodProtectionProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallFloodProtectionProfileBindingMap", 
  "type": "object"
}

ChildPolicyFirewallIpReputationConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallIpReputationConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallIpReputationConfig", 
  "module_id": "PolicyFirewallIpReputation", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyFirewallIpReputationConfig"
  }, 
  "properties": {
    "PolicyFirewallIpReputationConfig": {
      "$ref": "PolicyFirewallIpReputationConfig, 
      "description": "Contains the actual PolicyFirewallIpReputationConfig object.", 
      "required": true, 
      "title": "IP reputation config"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallIpReputationConfig", 
  "type": "object"
}

ChildPolicyFirewallScheduler (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallScheduler, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallScheduler", 
  "module_id": "PolicyFirewallScheduler", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyFirewallScheduler"
  }, 
  "properties": {
    "PolicyFirewallScheduler": {
      "$ref": "PolicyFirewallScheduler, 
      "description": "Contains the actual PolicyFirewallScheduler objects", 
      "required": true, 
      "title": "PolicyFirewallScheduler"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallScheduler", 
  "type": "object"
}

ChildPolicyFirewallSessionTimerProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallSessionTimerProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallSessionTimerProfile", 
  "module_id": "PolicyFirewallSessionTimerProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyFirewallSessionTimerProfile"
  }, 
  "properties": {
    "PolicyFirewallSessionTimerProfile": {
      "$ref": "PolicyFirewallSessionTimerProfile, 
      "description": "Contains the actual PolicyFirewallSessionTimerProfile object", 
      "required": true, 
      "title": "PolicyFirewallSessionTimerProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallSessionTimerProfile", 
  "type": "object"
}

ChildPolicyFirewallSessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallSessionTimerProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallSessionTimerProfileBindingMap", 
  "module_id": "PolicyFirewallSessionTimerProfileBinding", 
  "properties": {
    "PolicyFirewallSessionTimerProfileBindingMap": {
      "$ref": "PolicyFirewallSessionTimerProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallSessionTimerProfileBindingMap object", 
      "required": true, 
      "title": "PolicyFirewallSessionTimerProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallSessionTimerProfileBindingMap", 
  "type": "object"
}

ChildPolicyIgmpProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyIgmpProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyIgmpProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyIgmpProfile": {
      "$ref": "PolicyIgmpProfile, 
      "description": "Contains actual PolicyIgmpProfile.", 
      "required": true, 
      "title": "PolicyIgmpProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyIgmpProfile", 
  "type": "object"
}

ChildPolicyInterVrfRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyInterVrfRoutingConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyInterVrfRoutingConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "PolicyInterVrfRoutingConfig": {
      "$ref": "PolicyInterVrfRoutingConfig, 
      "description": "Contains actual PolicyInterVrfRoutingConfig.", 
      "required": true, 
      "title": "PolicyInterVrfRoutingConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for inter-vrf routing config", 
  "type": "object"
}

ChildPolicyLabel (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyLabel, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLabel", 
  "module_id": "PolicyLabel", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLabel"
  }, 
  "properties": {
    "PolicyLabel": {
      "$ref": "PolicyLabel, 
      "description": "Contains the actual PolicyLabel object", 
      "required": true, 
      "title": "PolicyLabel"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLabel", 
  "type": "object"
}

ChildPolicyLatencyStatProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyLatencyStatProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLatencyStatProfile", 
  "module_id": "PolicyLatency", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLatencyStatProfile"
  }, 
  "properties": {
    "PolicyLatencyStatProfile": {
      "$ref": "PolicyLatencyStatProfile, 
      "description": "Contains the actual PolicyLatencyStatProfile object", 
      "required": true, 
      "title": "PolicyLatencyStatProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLatencyStatProfile", 
  "type": "object"
}

ChildPolicyMulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyMulticastConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyMulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyMulticastConfig": {
      "$ref": "PolicyMulticastConfig, 
      "description": "Contains actual PolicyMulticastConfig.", 
      "required": true, 
      "title": "PolicyMulticastConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyMulticastConfig", 
  "type": "object"
}

ChildPolicyNat (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyNat, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyNat", 
  "module_id": "PolicyNAT", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyNat"
  }, 
  "properties": {
    "PolicyNat": {
      "$ref": "PolicyNat, 
      "description": "Contains the actual PolicyNAT object", 
      "required": true, 
      "title": "PolicyNat"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyNat", 
  "type": "object"
}

ChildPolicyNatRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyNatRule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyNatRule", 
  "module_id": "PolicyNAT", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyNatRule"
  }, 
  "properties": {
    "PolicyNatRule": {
      "$ref": "PolicyNatRule, 
      "description": "Contains the actual PolicyNatRule object", 
      "required": true, 
      "title": "PolicyNatRule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyNatRule", 
  "type": "object"
}

ChildPolicyPimProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyPimProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyPimProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyPimProfile": {
      "$ref": "PolicyPimProfile, 
      "description": "Contains actual PolicyPimProfile.", 
      "required": true, 
      "title": "PolicyPimProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyPimProfile", 
  "type": "object"
}

ChildPolicySIExcludeList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicySIExcludeList", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicySIExcludeList"
  }, 
  "properties": {
    "PolicySIExcludeList": {
      "$ref": "PolicySIExcludeList, 
      "description": "Contains the actual policy exclude list object.", 
      "required": true, 
      "title": "PolicySIExcludeList"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicySIExcludeList", 
  "type": "object"
}

ChildPolicyServiceChain (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceChain", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceChain"
  }, 
  "properties": {
    "PolicyServiceChain": {
      "$ref": "PolicyServiceChain, 
      "description": "Contains actual PolicyServiceChain.", 
      "required": true, 
      "title": "PolicyServiceChain"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceChain", 
  "type": "object"
}

ChildPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceInstance"
  }, 
  "properties": {
    "PolicyServiceInstance": {
      "$ref": "PolicyServiceInstance, 
      "description": "Contains actual PolicyServiceInstance.", 
      "required": true, 
      "title": "PolicyServiceInstance"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceInstance", 
  "type": "object"
}

ChildPolicyServiceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceProfile", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceProfile"
  }, 
  "properties": {
    "PolicyServiceProfile": {
      "$ref": "PolicyServiceProfile, 
      "description": "Contains actual PolicyServiceProfile.", 
      "required": true, 
      "title": "PolicyServiceProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceProfile", 
  "type": "object"
}

ChildPolicyTier1MulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyTier1MulticastConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTier1MulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyTier1MulticastConfig": {
      "$ref": "PolicyTier1MulticastConfig, 
      "description": "Contains actual PolicyTier1MulticastConfig.", 
      "required": true, 
      "title": "PolicyTier1MulticastConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTier1MulticastConfig", 
  "type": "object"
}

ChildPolicyTlsConfigProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyTlsConfigProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTlsConfigProfile", 
  "module_id": "PolicyTlsConfigProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyTlsConfigProfile"
  }, 
  "properties": {
    "PolicyTlsConfigProfile": {
      "$ref": "PolicyTlsConfigProfile, 
      "description": "Contains the actual PolicyTlsConfigProfile object", 
      "required": true, 
      "title": "PolicyTlsConfigProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTlsConfigProfile", 
  "type": "object"
}

ChildPolicyTransportZone (type)

{
  "description": "Child wrapper object for PolicyTransportZone, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTransportZone", 
  "module_id": "PolicyTransportZone", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyTransportZone"
  }, 
  "properties": {
    "PolicyTransportZone": {
      "$ref": "PolicyTransportZone, 
      "additionalProperties": false, 
      "description": "Contains the actual PolicyTransportZone object.", 
      "required": true, 
      "title": "PolicyTransportZone"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTransportZone", 
  "type": "object"
}

ChildPolicyTransportZoneProfile (type)

{
  "description": "Child wrapper object for PolicyTransportZoneProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTransportZoneProfile", 
  "module_id": "PolicyTransportZoneProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyTransportZoneProfile"
  }, 
  "properties": {
    "PolicyTransportZoneProfile": {
      "$ref": "PolicyTransportZoneProfile, 
      "additionalProperties": false, 
      "description": "Contains the actual PolicyTransportZoneProfile object.", 
      "required": true, 
      "title": "PolicyTransportZoneProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTransportZoneProfile", 
  "type": "object"
}

ChildPolicyUrlCategorizationConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyUrlCategorizationConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyUrlCategorizationConfig", 
  "module_id": "PolicyUrlCategorization", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyUrlCategorizationConfig"
  }, 
  "properties": {
    "PolicyUrlCategorizationConfig": {
      "$ref": "PolicyUrlCategorizationConfig, 
      "description": "Contains the actual PolicyUrlCategorizationConfig object", 
      "required": true, 
      "title": "URL Categorization Config"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyUrlCategorizationConfig", 
  "type": "object"
}

ChildPortDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortDiscoveryProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortDiscoveryProfileBindingMap"
  }, 
  "properties": {
    "PortDiscoveryProfileBindingMap": {
      "$ref": "PortDiscoveryProfileBindingMap, 
      "description": "Contains the actual PortDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "PortDiscoveryProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildPortMirroringProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortMirroringProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortMirroringProfile", 
  "module_id": "PolicyPortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortMirroringProfile"
  }, 
  "properties": {
    "PortMirroringProfile": {
      "$ref": "PortMirroringProfile, 
      "description": "Contains the actual PortMirroringProfile object", 
      "required": true, 
      "title": "PortMirroringProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortMirroringProfile", 
  "type": "object"
}

ChildPortMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortMonitoringProfileBindingMap"
  }, 
  "properties": {
    "PortMonitoringProfileBindingMap": {
      "$ref": "PortMonitoringProfileBindingMap, 
      "description": "Contains the actual PortMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "PortMonitoringProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortMonitoringProfileBindingMap", 
  "type": "object"
}

ChildPortQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortQoSProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortQoSProfileBindingMap"
  }, 
  "properties": {
    "PortQoSProfileBindingMap": {
      "$ref": "PortQoSProfileBindingMap, 
      "description": "Contains the actual PortQoSProfileBindingMap object", 
      "required": true, 
      "title": "PortQoSProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortQoSProfileBindingMap", 
  "type": "object"
}

ChildPortSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortSecurityProfileBindingMap"
  }, 
  "properties": {
    "PortSecurityProfileBindingMap": {
      "$ref": "PortSecurityProfileBindingMap, 
      "description": "Contains the actual PortSecurityProfileBindingMap object", 
      "required": true, 
      "title": "PortSecurityProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortSecurityProfileBindingMap", 
  "type": "object"
}

ChildPrefixList (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PrefixList, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPrefixList", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPrefixList"
  }, 
  "properties": {
    "PrefixList": {
      "$ref": "PrefixList, 
      "description": "Contains the actual PrefixList object.", 
      "required": true, 
      "title": "PrefixList"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PrefixList", 
  "type": "object"
}

ChildProject (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Project, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildProject", 
  "module_id": "PolicyProject", 
  "properties": {
    "Project": {
      "$ref": "Project, 
      "description": "Contains the actual Project object", 
      "required": true, 
      "title": "PROJECT"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PROJECT", 
  "type": "object"
}

ChildQoSProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for QoSProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildQoSProfile", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildQoSProfile"
  }, 
  "properties": {
    "QoSProfile": {
      "$ref": "QoSProfile, 
      "description": "Contains the actual QoSProfile object", 
      "required": true, 
      "title": "QoSProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for QoSProfile", 
  "type": "object"
}

ChildReaction (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Reaction used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildReaction", 
  "module_id": "PolicyReaction", 
  "properties": {
    "Reaction": {
      "$ref": "Reaction, 
      "description": "Contains the actual Reaction object.", 
      "required": true, 
      "title": "Reaction"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Reaction", 
  "type": "object"
}

ChildRedirectionPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for RedirectionPolicy used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRedirectionPolicy", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRedirectionPolicy"
  }, 
  "properties": {
    "RedirectionPolicy": {
      "$ref": "RedirectionPolicy, 
      "description": "Contains actual RedirectionPolicy.", 
      "required": true, 
      "title": "RedirectionPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for RedirectionPolicy\n", 
  "type": "object"
}

ChildRedirectionRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ChildRedirectionRule used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRedirectionRule", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRedirectionRule"
  }, 
  "properties": {
    "RedirectionRule": {
      "$ref": "RedirectionRule, 
      "description": "Contains actual RedirectionRule.", 
      "required": true, 
      "title": "RedirectionRule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for RedirectionRule\n", 
  "type": "object"
}

ChildResourceReference (type)

{
  "additionalProperties": false, 
  "description": "Represents a reference to ChildPolicyConfigResource in the hierarchical API. resource_type, id and target_type are mandatory fields.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildResourceReference", 
  "module_id": "Policy", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_type": {
      "required": true, 
      "title": "The target type of this reference", 
      "type": "string"
    }
  }, 
  "title": "Represents the reference to ChildPolicyConfigResource", 
  "type": "object"
}

ChildRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Rule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRule", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRule"
  }, 
  "properties": {
    "Rule": {
      "$ref": "Rule, 
      "description": "Contains the actual Rule object", 
      "required": true, 
      "title": "Rule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Rule", 
  "type": "object"
}

ChildSIStatusConfiguration (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSIStatusConfiguration", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicySIStatusConfiguration"
  }, 
  "properties": {
    "PolicySIStatusConfiguration": {
      "$ref": "PolicySIStatusConfiguration, 
      "description": "Contains the actual service insertion status configuration list object.", 
      "required": true
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicySIStatusConfiguration", 
  "type": "object"
}

ChildSecurityFeatures (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for T1 Security Feature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSecurityFeatures", 
  "module_id": "PolicyGatewaySecurityFeature", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSecurityFeatures"
  }, 
  "properties": {
    "SecurityFeatures": {
      "$ref": "SecurityFeatures, 
      "description": "Contains the actual SecurityFeatures object", 
      "required": true, 
      "title": "Security configs"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Security Feature", 
  "type": "object"
}

ChildSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SecurityPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSecurityPolicy", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSecurityPolicy"
  }, 
  "properties": {
    "SecurityPolicy": {
      "$ref": "SecurityPolicy, 
      "description": "Contains the actual SecurityPolicy object", 
      "required": true, 
      "title": "SecurityPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SecurityPolicy", 
  "type": "object"
}

ChildSegment (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Segment, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegment", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegment"
  }, 
  "properties": {
    "Segment": {
      "$ref": "Segment, 
      "description": "Contains the actual Segment object.", 
      "required": true, 
      "title": "Segment"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Segment", 
  "type": "object"
}

ChildSegmentDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentDiscoveryProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentDiscoveryProfileBindingMap"
  }, 
  "properties": {
    "SegmentDiscoveryProfileBindingMap": {
      "$ref": "SegmentDiscoveryProfileBindingMap, 
      "description": "Contains the actual SegmentDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "SegmentDiscoveryProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildSegmentMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentMonitoringProfileBindingMap"
  }, 
  "properties": {
    "SegmentMonitoringProfileBindingMap": {
      "$ref": "SegmentMonitoringProfileBindingMap, 
      "description": "Contains the actual SegmentMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "SegmentMonitoringProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentMonitoringProfileBindingMap", 
  "type": "object"
}

ChildSegmentPort (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentPort, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentPort", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentPort"
  }, 
  "properties": {
    "SegmentPort": {
      "$ref": "SegmentPort, 
      "description": "Contains the actual SegmentPort object", 
      "required": true, 
      "title": "SegmentPort"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentPort", 
  "type": "object"
}

ChildSegmentQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentQoSProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentQoSProfileBindingMap"
  }, 
  "properties": {
    "SegmentQoSProfileBindingMap": {
      "$ref": "SegmentQoSProfileBindingMap, 
      "description": "Contains the actual SegmentQoSProfileBindingMap object", 
      "required": true, 
      "title": "SegmentQoSProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentQoSProfileBindingMap", 
  "type": "object"
}

ChildSegmentSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentSecurityProfile", 
  "module_id": "PolicySegmentSecurity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentSecurityProfile"
  }, 
  "properties": {
    "SegmentSecurityProfile": {
      "$ref": "SegmentSecurityProfile, 
      "description": "Contains the actual SegmentSecurityProfile object", 
      "required": true, 
      "title": "SegmentSecurityProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentSecurityProfile", 
  "type": "object"
}

ChildSegmentSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentSecurityProfileBindingMap"
  }, 
  "properties": {
    "SegmentSecurityProfileBindingMap": {
      "$ref": "SegmentSecurityProfileBindingMap, 
      "description": "Contains the actual SegmentSecurityProfileBindingMap object", 
      "required": true, 
      "title": "SegmentSecurityProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentSecurityProfileBindingMap", 
  "type": "object"
}

ChildService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Service, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildService", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildService"
  }, 
  "properties": {
    "Service": {
      "$ref": "Service, 
      "description": "Contains the actual Service object.", 
      "required": true, 
      "title": "Service"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Service", 
  "type": "object"
}

ChildServiceEntry (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceEntry, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceEntry"
  }, 
  "properties": {
    "Service": {
      "$ref": "ServiceEntry, 
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'ServiceEntry' instead.", 
      "title": "ServiceEntry"
    }, 
    "ServiceEntry": {
      "$ref": "ServiceEntry, 
      "description": "Contains the actual ServiceEntry object.", 
      "required": true, 
      "title": "ServiceEntry"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceEntry", 
  "type": "object"
}

ChildServiceInstanceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceInstanceEndpoint used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceInstanceEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceInstanceEndpoint"
  }, 
  "properties": {
    "ServiceInstanceEndpoint": {
      "$ref": "ServiceInstanceEndpoint, 
      "description": "Contains actual ServiceInstanceEndpoint.", 
      "required": true, 
      "title": "ServiceInstanceEndpoint"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceInstanceEndpoint", 
  "type": "object"
}

ChildServiceInterface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceInterface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceInterface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceInterface"
  }, 
  "properties": {
    "ServiceInterface": {
      "$ref": "ServiceInterface, 
      "description": "Contains the actual ServiceInterface object.", 
      "required": true, 
      "title": "ServiceInterface"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceInterface", 
  "type": "object"
}

ChildServiceReference (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceReference used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceReference", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceReference"
  }, 
  "properties": {
    "ServiceReference": {
      "$ref": "ServiceReference, 
      "description": "Contains actual ServiceReference.", 
      "required": true, 
      "title": "ServiceReference"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceReference", 
  "type": "object"
}

ChildServiceSegment (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceSegment, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceSegment", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceSegment"
  }, 
  "properties": {
    "ServiceSegment": {
      "$ref": "ServiceSegment, 
      "description": "Contains the actual ServiceSegment objects", 
      "required": true, 
      "title": "ServiceSegments"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SerivceSegment", 
  "type": "object"
}

ChildSessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SessionTimerProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSessionTimerProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSessionTimerProfileBindingMap"
  }, 
  "properties": {
    "SessionTimerProfileBindingMap": {
      "$ref": "SessionTimerProfileBindingMap, 
      "description": "Contains the actual SessionTimerProfileBindingMap object", 
      "required": true, 
      "title": "SessionTimerProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SessionTimerProfileBindingMap", 
  "type": "object"
}

ChildShaDynamicPlugin (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ShaDynamicPlugin, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildShaDynamicPlugin", 
  "module_id": "PolicySha", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildShaDynamicPlugin"
  }, 
  "properties": {
    "ShaPluginProfile": {
      "$ref": "ShaDynamicPlugin, 
      "description": "Contains the actual ShaDynamicPlugin object", 
      "required": true, 
      "title": "ShaDynamicPlugin"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ShaDynamicPlugin", 
  "type": "object"
}

ChildShaPluginProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ShaPluginProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildShaPluginProfile", 
  "module_id": "PolicySha", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildShaPluginProfile"
  }, 
  "properties": {
    "ShaPluginProfile": {
      "$ref": "ShaPluginProfile, 
      "description": "Contains the actual ShaPluginProfile object", 
      "required": true, 
      "title": "ShaPluginProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ShaPluginProfile", 
  "type": "object"
}

ChildShaPredefinedPlugin (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ShaPredefinedPlugin, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildShaPredefinedPlugin", 
  "module_id": "PolicySha", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildShaPredefinedPlugin"
  }, 
  "properties": {
    "ShaPluginProfile": {
      "$ref": "ShaPredefinedPlugin, 
      "description": "Contains the actual ShaPredefinedPlugin object", 
      "required": true, 
      "title": "ShaPredefinedPlugin"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ShaDynamicPlugin", 
  "type": "object"
}

ChildShare (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Share, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildShare", 
  "module_id": "PolicyShare", 
  "properties": {
    "Share": {
      "$ref": "Share, 
      "description": "Contains the actual Share object", 
      "required": true, 
      "title": "Share"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Share", 
  "type": "object"
}

ChildSharedResource (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SharedResource, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSharedResource", 
  "module_id": "PolicyShare", 
  "properties": {
    "SharedResource": {
      "$ref": "SharedResource, 
      "description": "Contains the actual SharedResource object", 
      "required": true, 
      "title": "SharedResource"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SharedResource", 
  "type": "object"
}

ChildSite (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Site, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSite", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSite"
  }, 
  "properties": {
    "Site": {
      "$ref": "Site, 
      "description": "Contains the actual Site object.", 
      "required": true, 
      "title": "Site"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Site", 
  "type": "object"
}

ChildSpoofGuardProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SpoofGuardProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSpoofGuardProfile", 
  "module_id": "PolicySpoofGuard", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSpoofGuardProfile"
  }, 
  "properties": {
    "SpoofGuardProfile": {
      "$ref": "SpoofGuardProfile, 
      "description": "Contains the actual SpoofGuardProfile object", 
      "required": true, 
      "title": "SpoofGuardProfile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SpoofGuardProfile", 
  "type": "object"
}

ChildStandaloneHostIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStandaloneHostIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStandaloneHostIdfwConfiguration"
  }, 
  "properties": {
    "StandaloneHostIdfwConfiguration": {
      "$ref": "StandaloneHostIdfwConfiguration, 
      "description": "Contains the actual standalone host idfw configuration object.", 
      "required": true, 
      "title": "StandaloneHostIdfwConfiguration"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StandaloneHostIdfwConfiguration", 
  "type": "object"
}

ChildStaticARPConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for StaticARPConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticARPConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticARPConfig"
  }, 
  "properties": {
    "StaticARPConfig": {
      "$ref": "StaticARPConfig, 
      "description": "Contains the actual StaticARPConfig object.", 
      "required": true, 
      "title": "StaticARPConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticARPConfig", 
  "type": "object"
}

ChildStaticMimeContent (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Static MIME content, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticMimeContent", 
  "module_id": "PolicyStaticMimeContent", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticMimeContent"
  }, 
  "properties": {
    "TlsProfile": {
      "$ref": "StaticMimeContent, 
      "description": "Contains the actual Static MIME content object.", 
      "required": true, 
      "title": "Static Mime Content"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Child Static MIME content", 
  "type": "object"
}

ChildStaticRouteBfdPeer (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for StaticRouteBfdPeer, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticRouteBfdPeer", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticRouteBfdPeer"
  }, 
  "properties": {
    "BfdPeer": {
      "$ref": "StaticRouteBfdPeer, 
      "description": "Contains the actual StaticRouteBfdPeer object.", 
      "required": true, 
      "title": "Static Route BFD Peer"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticRouteBfdPeer", 
  "type": "object"
}

ChildStaticRoutes (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for StaticRoutes, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticRoutes", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticRoutes"
  }, 
  "properties": {
    "StaticRoutes": {
      "$ref": "StaticRoutes, 
      "description": "Contains the actual StaticRoutes object.", 
      "required": true, 
      "title": "StaticRoutes"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticRoutes", 
  "type": "object"
}

ChildTagBulkOperation (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for TagBulkOperation, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTagBulkOperation", 
  "module_id": "PolicyTag", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTagBulkOperation"
  }, 
  "properties": {
    "TagBulkOperation": {
      "$ref": "TagBulkOperation, 
      "description": "Contains actual TagBulkOperation object.", 
      "required": true, 
      "title": "TagBulkOperation"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Child wrapper object for TagBulkOperation", 
  "type": "object"
}

ChildTier0 (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier-0, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0"
  }, 
  "properties": {
    "Tier0": {
      "$ref": "Tier0, 
      "description": "Contains the actual Tier-0 object.", 
      "required": true, 
      "title": "Tier-0"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier-0", 
  "type": "object"
}

ChildTier0DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0DeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0DeploymentMap"
  }, 
  "properties": {
    "Tier0DeploymentMap": {
      "$ref": "Tier0DeploymentMap, 
      "description": "Contains the actual Tier0DeploymentMap object.", 
      "required": true, 
      "title": "Tier0DeploymentMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0DeploymentMap", 
  "type": "object"
}

ChildTier0Interface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0Interface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0Interface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0Interface"
  }, 
  "properties": {
    "Tier0Interface": {
      "$ref": "Tier0Interface, 
      "description": "Contains the actual Tier0Interface object.", 
      "required": true, 
      "title": "Tier0Interface"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0Interface", 
  "type": "object"
}

ChildTier0InterfaceGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0InterfaceGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0InterfaceGroup", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0InterfaceGroup"
  }, 
  "properties": {
    "Tier0InterfaceGroup": {
      "$ref": "Tier0InterfaceGroup, 
      "description": "Contains the actual Tier0InterfaceGroup object.", 
      "required": true, 
      "title": "Tier0InterfaceGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0InterfaceGroup", 
  "type": "object"
}

ChildTier0RouteMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0RouteMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0RouteMap", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0RouteMap"
  }, 
  "properties": {
    "Tier0RouteMap": {
      "$ref": "Tier0RouteMap, 
      "description": "Contains the actual Tier0RouteMap object", 
      "required": true, 
      "title": "Tier0RouteMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0RouteMap", 
  "type": "object"
}

ChildTier0SecurityFeatures (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for T0 Security Feature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0SecurityFeatures", 
  "module_id": "PolicyGatewaySecurityFeature", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0SecurityFeatures"
  }, 
  "properties": {
    "Tier0SecurityFeatures": {
      "$ref": "Tier0SecurityFeatures, 
      "description": "Contains the actual TO SecurityFeatures object", 
      "required": true, 
      "title": "T0 Security configs"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for T0 Security Feature", 
  "type": "object"
}

ChildTier1 (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier-1 , used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1"
  }, 
  "properties": {
    "Tier1": {
      "$ref": "Tier1, 
      "description": "Contains the actual Tier-1 object.", 
      "required": true, 
      "title": "Tier-1"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier-1", 
  "type": "object"
}

ChildTier1DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier1DeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1DeploymentMap"
  }, 
  "properties": {
    "Tier1DeploymentMap": {
      "$ref": "Tier1DeploymentMap, 
      "description": "Contains the actual Tier1DeploymentMap object.", 
      "required": true, 
      "title": "Tier1DeploymentMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier1DeploymentMap", 
  "type": "object"
}

ChildTier1Interface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier1Interface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1Interface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1Interface"
  }, 
  "properties": {
    "Tier1Interface": {
      "$ref": "Tier1Interface, 
      "description": "Contains the actual Tier1Interface object.", 
      "required": true, 
      "title": "Tier1Interface"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier1Interface", 
  "type": "object"
}

ChildTier1InterfaceGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier1InterfaceGroup, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1InterfaceGroup", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1InterfaceGroup"
  }, 
  "properties": {
    "Tier1InterfaceGroup": {
      "$ref": "Tier1InterfaceGroup, 
      "description": "Contains the actual Tier1InterfaceGroup object.", 
      "required": true, 
      "title": "Tier1InterfaceGroup"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier1InterfaceGroup", 
  "type": "object"
}

ChildTlsCertificate (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsCertificate, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsCertificate", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsCertificate"
  }, 
  "properties": {
    "TlsCertificate": {
      "$ref": "TlsCertificate, 
      "description": "Contains the actual TlsCertificate object.", 
      "required": true, 
      "title": "TlsCertificate"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsCertificate", 
  "type": "object"
}

ChildTlsConfigProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for TlsConfigProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsConfigProfileBindingMap", 
  "module_id": "PolicyTlsConfigProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsConfigProfileBindingMap"
  }, 
  "properties": {
    "SessionTimerProfileBindingMap": {
      "$ref": "TlsConfigProfileBindingMap, 
      "description": "Contains the actual TlsConfigProfileBindingMap object", 
      "required": true, 
      "title": "TlsConfigProfileBindingMap"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsConfigProfileBindingMap", 
  "type": "object"
}

ChildTlsCrl (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsCrl, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsCrl", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsCrl"
  }, 
  "properties": {
    "TlsCrl": {
      "$ref": "TlsCrl, 
      "description": "Contains the actual TlsCrl object.", 
      "required": true, 
      "title": "TlsCrl"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsCrl", 
  "type": "object"
}

ChildTlsPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for TLSPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsPolicy", 
  "module_id": "PolicyTls", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsPolicy"
  }, 
  "properties": {
    "TlsPolicy": {
      "$ref": "TlsPolicy, 
      "description": "Contains the actual TLSPolicy object", 
      "required": true, 
      "title": "TlsPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsPolicy", 
  "type": "object"
}

ChildTlsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for TLS Profile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsProfile", 
  "module_id": "PolicyTlsActionProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsProfile"
  }, 
  "properties": {
    "TlsProfile": {
      "$ref": "TlsProfile, 
      "description": "Contains the actual TLS profile object.", 
      "required": true, 
      "title": "TLS Profile"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Child TLS Profile", 
  "type": "object"
}

ChildTlsRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Rule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsRule", 
  "module_id": "PolicyTls", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsRule"
  }, 
  "properties": {
    "TlsRule": {
      "$ref": "TlsRule, 
      "description": "Contains the actual TLS Rule object", 
      "required": true, 
      "title": "TLS Rule"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Rule", 
  "type": "object"
}

ChildTlsTrustData (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsTrustData, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsTrustData", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsTrustData"
  }, 
  "properties": {
    "TlsTrustData": {
      "$ref": "TlsTrustData, 
      "description": "Contains the actual TlsTrustData object.", 
      "required": true, 
      "title": "TlsTrustData"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsTrustData", 
  "type": "object"
}

ChildTraceflowConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TraceflowConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTraceflowConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTraceflowConfig"
  }, 
  "properties": {
    "TraceflowConfig": {
      "$ref": "TraceflowConfig, 
      "description": "Contains the actual TraceflowConfig object.", 
      "required": true, 
      "title": "TraceflowConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TraceflowConfig", 
  "type": "object"
}

ChildTypesRequestParameter (type)

{
  "description": "Specified child resource types will be populated in the response body", 
  "id": "ChildTypesRequestParameter", 
  "module_id": "Policy", 
  "properties": {
    "base_path": {
      "description": "Base path of the resource for which user wants to retrieve the hierarchy. This should be the fully qualified path for the resource. - Sample examples - base_path=/infra/domains/default/groups/Group1 base_path=/infra/domains/default/security-policies/SecurityPolicy1/rules/Rule1", 
      "required": false, 
      "title": "Base Path for retrieving hierarchical intent", 
      "type": "string"
    }, 
    "filter": {
      "description": "Filter string, can contain multiple or single java regular expressions separated by ';'. By default populates immediate child resources of the resource indicated by the URL. These child resources will be filtered by the type provided in the filter. It is recommended to use type_filter parameter instead of filter parameter. - Sample query string to prevent loading services and deployment zones: filter=Type-^(?!.*?(?:Service|DeploymentZone)).*$ - Sample query string to populate all the Group objects under Infra & Domain: filter=Type-Domain%7CGroup - Sample query string to load every policy object under Infra: filter=Type-.*", 
      "required": false, 
      "title": "Filter string as java regex", 
      "type": "string"
    }, 
    "type_filter": {
      "description": "Advanced filter string in which user can directly specify the resourceTypes to be filtered. Can be used in conjunction with base_path. - Sample example of type_filter to load all groups - type_filter=Group - Sample example of multiple type_filter - type_filter=Group;SercurityPolicy;RedirectionPolicy - Sample eaxmple to load all groups in default domain using base_path in conjunction with type_filter - base_path=/infra/domains/default&type_filter=Group", 
      "required": false, 
      "title": "Filter string to retrieve hierarchy.", 
      "type": "string"
    }
  }, 
  "title": "Filter to populate child types of the policyConfigResource", 
  "type": "object"
}

ChildVMTagReplicationPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for VMTagReplicationPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildVMTagReplicationPolicy", 
  "module_id": "VMTagReplicationPolicy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildVMTagReplicationPolicy"
  }, 
  "properties": {
    "VMTagReplicationPolicy": {
      "$ref": "VMTagReplicationPolicy, 
      "description": "Contains the actual VMTagReplicationPolicy object", 
      "required": true, 
      "title": "VMTagReplicationPolicy"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for VMTagReplicationPolicy", 
  "type": "object"
}

ChildVirtualEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for VirtualEndpoint used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildVirtualEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildVirtualEndpoint"
  }, 
  "properties": {
    "VirtualEndpoint": {
      "$ref": "VirtualEndpoint, 
      "description": "Contains reference to actual VirtualEndpoint.", 
      "required": true, 
      "title": "VirtualEndpoint"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for VirtualEndpoint", 
  "type": "object"
}

ChildVniPoolConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for VniPoolConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildVniPoolConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildVniPoolConfig"
  }, 
  "properties": {
    "VniPoolConfig": {
      "$ref": "VniPoolConfig, 
      "description": "Contains the actual VniPoolConfig object.", 
      "required": true, 
      "title": "VniPoolConfig"
    }, 
    "_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"
    }, 
    "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"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "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.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "request_parameter": {
      "$ref": "PolicyRequestParameter, 
      "required": false, 
      "title": "Generic type for passing the API request parameters."
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for VniPoolConfig", 
  "type": "object"
}

CidrArrayConstraintValue (type)

{
  "additionalProperties": false, 
  "description": "List of CIDR values", 
  "extends": {
    "$ref": "ConstraintValue
  }, 
  "id": "CidrArrayConstraintValue", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CidrArrayConstraintValue"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StringArrayConstraintValue", 
        "CidrArrayConstraintValue", 
        "IntegerArrayConstraintValue"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "values": {
      "description": "This array can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed. Supported list of formats are, \"192.168.1.1\", \"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\", \"fe80::250:56ff:fe83:318c\", \"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\", \"fe80::250:56ff:fe83:318c/64\".", 
      "items": {
        "$ref": "IPElement
      }, 
      "maxItems": 100, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of IP addresses", 
      "type": "array"
    }
  }, 
  "title": "Array of CIDR Values to perform operation", 
  "type": "object"
}

CidrBlock (type)

{
  "additionalProperties": false, 
  "description": "Stores information about IPv4 CIDR block.", 
  "format": "ipv4-cidr-block", 
  "id": "CidrBlock", 
  "module_id": "CloudServiceManager", 
  "title": "IPv4 CIDR Block", 
  "type": "string"
}

CipherSuite (type)

{
  "additionalProperties": false, 
  "id": "CipherSuite", 
  "module_id": "ApiServiceConfig", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "Enable status for this cipher suite", 
      "type": "boolean"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the TLS cipher suite", 
      "type": "string"
    }
  }, 
  "title": "HTTP cipher suite", 
  "type": "object"
}

ClaimMap (type)

{
  "description": "Information about how to map a single OIDC ID token claim to one or more NSX roles.", 
  "id": "ClaimMap", 
  "module_id": "CertificateManager", 
  "properties": {
    "claim_name": {
      "type": "string"
    }, 
    "value_to_role_map": {
      "items": {
        "$ref": "ClaimValueToRoleMap
      }, 
      "type": "array"
    }
  }, 
  "title": "Claim map", 
  "type": "object"
}

ClaimValueToRoleMap (type)

{
  "descrption": "Information about how to map one value of an OIDC ID token claim to one or more NSX roles.", 
  "id": "ClaimValueToRoleMap", 
  "module_id": "CertificateManager", 
  "properties": {
    "claim_value": {
      "description": "The value of the claim to map.", 
      "title": "Claim value", 
      "type": "string"
    }, 
    "roles": {
      "description": "The NSX roles that this particular claim value should map to.", 
      "items": {
        "type": "string"
      }, 
      "title": "Mapped roles", 
      "type": "array"
    }
  }, 
  "title": "Claim value map", 
  "type": "object"
}

ClasslessStaticRoute (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP classless static route option.", 
  "id": "ClasslessStaticRoute", 
  "module_id": "Dhcp", 
  "properties": {
    "network": {
      "$ref": "IPElement, 
      "description": "Destination network in CIDR format.", 
      "required": true, 
      "title": "Destination in CIDR"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "IP address of next hop of the route.", 
      "required": true, 
      "title": "Router"
    }
  }, 
  "title": "DHCP classless static route option", 
  "type": "object"
}

ClearPasswordActionParameters (type)

{
  "id": "ClearPasswordActionParameters", 
  "module_id": "Routing", 
  "properties": {
    "action": {
      "enum": [
        "clear_password"
      ], 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClientAuthType (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Client authentication could be REQUIRED or IGNORE. REQUIRED means that client is required to present its certificate to the server for authentication. To be accepted, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified in the same client SSL profile binding. IGNORE means that client certificate would be ignored.", 
  "enum": [
    "REQUIRED", 
    "IGNORE"
  ], 
  "id": "ClientAuthType", 
  "module_id": "LoadBalancer", 
  "title": "client authentication mode", 
  "type": "string"
}

ClientSslProfileBinding (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "id": "ClientSslProfileBinding", 
  "module_id": "LoadBalancer", 
  "properties": {
    "certificate_chain_depth": {
      "default": 3, 
      "description": "authentication depth is used to set the verification depth in the client certificates chain.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the maximum traversal depth of client certificate chain", 
      "type": "integer"
    }, 
    "client_auth": {
      "$ref": "ClientAuthType, 
      "default": "IGNORE", 
      "required": false, 
      "title": "client authentication mode"
    }, 
    "client_auth_ca_ids": {
      "description": "If client auth type is REQUIRED, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA identifier list to verify client certificate", 
      "type": "array"
    }, 
    "client_auth_crl_ids": {
      "description": "A Certificate Revocation List (CRL) can be specified in the client-side SSL profile binding to disallow compromised client certificates.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL identifier list to verify client certificate", 
      "type": "array"
    }, 
    "default_certificate_id": {
      "description": "A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.", 
      "required": true, 
      "title": "default service certificate identifier", 
      "type": "string"
    }, 
    "sni_certificate_ids": {
      "description": "Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "SNI certificate identifier list", 
      "type": "array"
    }, 
    "ssl_profile_id": {
      "description": "Client SSL profile defines reusable, application-independent client side SSL properties.", 
      "required": false, 
      "title": "client SSL profile identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClientTypeCollectionConfiguration (type)

{
  "id": "ClientTypeCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "client_type": {
      "description": "The client type for which this data collection frequency setting applies", 
      "enum": [
        "HYPERVISOR", 
        "EDGE", 
        "CONTROL_PLANE", 
        "CONTROL_PLANE_PLATFORM", 
        "MANAGEMENT_PLANE", 
        "MANAGEMENT_PLANE_PLATFORM"
      ], 
      "required": true, 
      "title": "Client Type", 
      "type": "string"
    }, 
    "data_type_configurations": {
      "description": "The set of data collection type configurations, one for each data collection type", 
      "items": {
        "$ref": "DataTypeCollectionConfiguration
      }, 
      "required": true, 
      "title": "Data type configurations", 
      "type": "array"
    }
  }, 
  "title": "HPM client data collection configuration", 
  "type": "object"
}

CloudAccount (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a cloud account like cloud type and insatnce statistics.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CloudAccount", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "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"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual machines.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "last_inventory_sync_date": {
      "description": "Time when last inventory syncing completed.", 
      "readonly": true, 
      "required": false, 
      "title": "Last inventory sync date", 
      "type": "integer"
    }, 
    "regions_config": {
      "$ref": "RegionListConfig, 
      "description": "Configured list of regions to be used for the cloud account.", 
      "readonly": false, 
      "required": false, 
      "title": "List of regions configuration for the cloud account"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud Account", 
  "type": "object"
}

CloudAccountStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores the status of cloud account like credentials validity status and inventory synchronization status.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CloudAccountStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }
  }, 
  "title": "Cloud Account status", 
  "type": "object"
}

CloudErrorDetails (type)

{
  "additionalProperties": false, 
  "description": "Stores information about error.", 
  "id": "CloudErrorDetails", 
  "module_id": "CloudTypes", 
  "properties": {
    "error_id": {
      "description": "ID of the error.", 
      "readonly": true, 
      "required": false, 
      "title": "Error ID", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Detailed message about the error.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }
  }, 
  "title": "Cloud Error Details", 
  "type": "object"
}

CloudGatewayPrivateIpAddress (type)

{
  "additionalProperties": false, 
  "id": "CloudGatewayPrivateIpAddress", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "gateway_ha_index": {
      "minimum": 0, 
      "readonly": true, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "private_ip": {
      "description": "The secondary Private IP allocated on the gateway's uplink interface.", 
      "format": "ipv4", 
      "readonly": true, 
      "title": "Secondary Private IP", 
      "type": "string"
    }
  }, 
  "title": "Private IP address of the gateway", 
  "type": "object"
}

CloudIpAllocationConfig (type)

{
  "additionalProperties": false, 
  "description": "Configuration parameters to create IP allocations that will be used for containers. These containers will be deployed in an Aws Vpc or Azure Vnet.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CloudIpAllocationConfig", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "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"
    }, 
    "ip_allocation_mode": {
      "default": "PUBLIC_IP", 
      "description": "PUBLIC_IP: Allocate new public IP. LINK_LOCAL_IP: Allocate new link local IP.", 
      "enum": [
        "PUBLIC_IP", 
        "LINK_LOCAL_IP"
      ], 
      "title": "IP Allocation Mode", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "number_of_allocations": {
      "desription": "The number of public/link local IP allocations requested.\n", 
      "readonly": false, 
      "required": true, 
      "title": "Number of IP allocations required.", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud IP Allocation Configuration", 
  "type": "object"
}

CloudIpAllocationMapping (type)

{
  "additionalProperties": false, 
  "description": "Information about Cloud IP mapping and allocation state.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CloudIpAllocationMapping", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "allocated_ip": {
      "desription": "The public/link local IP allocated for the IP mapping.", 
      "format": "ipv4", 
      "readonly": true, 
      "title": "Public/link local IP", 
      "type": "string"
    }, 
    "gateway_private_ips": {
      "description": "List of secondary Private IPs allocated on the gateway's uplink interface.", 
      "items": {
        "$ref": "CloudGatewayPrivateIpAddress
      }, 
      "readonly": true, 
      "title": "Secondary Private IP Addresses", 
      "type": "array"
    }
  }, 
  "title": "Cloud IP Allocation Mapping", 
  "type": "object"
}

CloudIpAllocationMappings (type)

{
  "additionalProperties": false, 
  "description": "Information about Cloud IP mappings.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CloudIpAllocationMappings", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "readonly": true, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "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"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for IP allocation failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for IP allocation failure", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "readonly": true, 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "ip_mappings": {
      "description": "IP mappings for a foundation.", 
      "items": {
        "$ref": "CloudIpAllocationMapping
      }, 
      "readonly": true, 
      "type": "array"
    }, 
    "ip_operation_status": {
      "description": "Indicates the state of the IP allocation or de-allocation. ALLOCATION_IN_PROGRESS: IP allocation is in progress. DELETION_IN_PROGRESS: IP de-allocation or deletion is in progress. SUCCESSFUL: IP allocation is successful. Successful de-allocation can be confirmed if the status API for this mapping returns a 404 error. FAILED: IP allocation or de-allocation failed.", 
      "enum": [
        "ALLOCATION_IN_PROGRESS", 
        "DELETION_IN_PROGRESS", 
        "SUCCESSFUL", 
        "FAILED"
      ], 
      "readonly": true, 
      "title": "IP Allocation State", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud IP Allocation Mappings", 
  "type": "object"
}

CloudNativeDeploymentAction (type)

{
  "additionalProperties": false, 
  "description": "Action to be perform on deployment.", 
  "id": "CloudNativeDeploymentAction", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "action": {
      "description": "Action can be deploy or undeploy. DEPLOY - Deploy NSX Application Platform charts. UNDEPLOY - Undeploy NSX Application Platform charts. REDEPLOY - Redeploy NSX Application Platform charts. UPDATE_FORMFACTOR - Upgrade NSX Application Platform charts. REDEPLOY_UPDATE_FORMFACTOR - Retry update NSX Application Platform charts. FORCE_UNDEPLOY - Undeploy forcefully. RESTART - Restart deployment. RESET - Reset deployment.", 
      "enum": [
        "DEPLOY", 
        "UNDEPLOY", 
        "REDEPLOY", 
        "UPDATE_FORMFACTOR", 
        "REDEPLOY_UPDATE_FORMFACTOR", 
        "FORCE_UNDEPLOY", 
        "RESTART", 
        "RESET"
      ], 
      "required": true, 
      "title": "Deployment action", 
      "type": "string"
    }
  }, 
  "title": "Action", 
  "type": "object"
}

CloudNativeDeploymentConfig (type)

{
  "additionalProperties": false, 
  "description": "Configuration for NSX Application Platform deployment.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CloudNativeDeploymentConfig", 
  "module_id": "PolicyCloudNative", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cluster_id": {
      "description": "Unique id to identify kubernetes guest cluster.", 
      "required": false, 
      "title": "Kubernetes cluster id", 
      "type": "string"
    }, 
    "deployment_action": {
      "$ref": "CloudNativeDeploymentAction, 
      "title": "Deployment action"
    }, 
    "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"
    }, 
    "kubeconf_info": {
      "$ref": "KubeconfigInfo, 
      "description": "Information about kubeconfig file.", 
      "title": "Kubeconfig info"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "storage_class": {
      "description": "Kubernetes cluster storage class", 
      "title": "Storage class", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "version": {
      "description": "Deployment version in use.", 
      "title": "Deployment version", 
      "type": "string"
    }
  }, 
  "title": "Common configuration for NSX Application Platform deployments", 
  "type": "object"
}

CloudNativeServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Stores the information about cloud native service instance.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "CloudNativeServiceInstance", 
  "module_id": "InventoryCloudObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Id of service instance fetched from public cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "External id of cloud native service instance in the system.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_type": {
      "description": "Type of cloud native service.", 
      "readonly": true, 
      "required": true, 
      "title": "Type of cloud native service; possible values are ELB, RDS", 
      "type": "string"
    }, 
    "source": {
      "$ref": "ResourceReference, 
      "description": "Reference of the public cloud gateway that reported the service instance.", 
      "readonly": true, 
      "required": true, 
      "title": "Reference of the public cloud gateway"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CloudNativeServiceInstanceListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters to get list of cloud native service instances.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "CloudNativeServiceInstanceListRequestParameters", 
  "module_id": "InventoryCloudObj", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Name of cloud native service instance.", 
      "required": false, 
      "title": "Display Name of the cloud native service instance", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "service_type": {
      "description": "Type of cloud native service.", 
      "required": false, 
      "title": "Type of cloud native service; possible values are ELB, RDS", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "description": "NSX node id of the public cloud gateway that reported the service instance.", 
      "required": false, 
      "title": "NSX node id of the public cloud gateway that reported the service instance", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CloudNativeServiceInstanceListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of cloud native service instances and information about them. NSX supported service instances are currently  limited to Relational Database Service (RDS),Elastic Load Balancing (ELB).", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CloudNativeServiceInstanceListResult", 
  "module_id": "InventoryCloudObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of cloud native service instances", 
      "items": {
        "$ref": "CloudNativeServiceInstance
      }, 
      "required": true, 
      "title": "CloudNativeServiceInstance list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CloudSecurityGroup (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a cloud security group.", 
  "extends": {
    "$ref": "SecurityGroup
  }, 
  "id": "CloudSecurityGroup", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cloud_tags": {
      "description": "Array of tags associated to a cloud security group.", 
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "title": "Cloud Tags", 
      "type": "array"
    }, 
    "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"
    }, 
    "instances_count": {
      "description": "Number of instances associated to cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Count Of Instances", 
      "type": "integer"
    }, 
    "is_managed_by_nsx": {
      "description": "If the flag is true, the cloud security group is managed by NSX.", 
      "readonly": true, 
      "required": false, 
      "title": "Is Managed By NSX", 
      "type": "boolean"
    }, 
    "region_id": {
      "description": "ID of the cloud region.", 
      "readonly": true, 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud Security Group", 
  "type": "object"
}

CloudSecurityGroupRule (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a cloud security group rule.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "CloudSecurityGroupRule", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination": {
      "description": "Destination corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Destination", 
      "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"
    }, 
    "port_range": {
      "description": "Port range corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Port Range", 
      "type": "string"
    }, 
    "protocol": {
      "description": "Protocol corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Protocol", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "source": {
      "description": "Source corresponding to the cloud security group rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Source", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud Security Group Rule", 
  "type": "object"
}

CloudServiceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Stores information about any service endpoint which is provided in the cloud. Example services include the cloud provided equivalent service for Storage, Database or Load Balancer.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "CloudServiceEndpoint", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "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"
    }, 
    "nsx_security_groups": {
      "description": "Stores an array of NSX security groups associated to this cloud service endpoint.", 
      "items": {
        "$ref": "SecurityGroup
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX security groups array", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_endpoint_id": {
      "description": "Cloud provided ID of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint ID", 
      "type": "string"
    }, 
    "service_endpoint_type": {
      "description": "Cloud provided type of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint Type", 
      "type": "string"
    }, 
    "service_name": {
      "description": "Name of the cloud service the endpoint is associated with.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud Service Endpoint", 
  "type": "object"
}

CloudTag (type)

{
  "additionalProperties": false, 
  "description": "Stores the key-value pair of cloud tag.", 
  "id": "CloudTag", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "key": {
      "description": "Key of the cloud tag.", 
      "readonly": true, 
      "required": false, 
      "title": "Tag Key", 
      "type": "string"
    }, 
    "value": {
      "description": "Value of the cloud tag.", 
      "readonly": true, 
      "required": false, 
      "title": "Tag Value", 
      "type": "string"
    }
  }, 
  "title": "Cloud Tag", 
  "type": "object"
}

CloudTypeConfig (type)

{
  "additionalProperties": false, 
  "description": "These parameters will be used to display the list of clouds and whether they are enabled (desired) / disabled (undesired) by the user.", 
  "extends": {
    "$ref": "CloudTypeInfo
  }, 
  "id": "CloudTypeConfig", 
  "module_id": "CloudAccounts", 
  "properties": {
    "cloud_type": {
      "description": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST", 
        "AZURE_GOV_US"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "enabled": {
      "description": "A particular cloud type is configured by the user to be enabled or not in the list of desired cloud types.", 
      "required": true, 
      "title": "Flag to enable specific cloud-type to be managed by CSM", 
      "type": "boolean"
    }
  }, 
  "title": "Cloud types information", 
  "type": "object"
}

CloudTypeConfigList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CloudTypeConfigList", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "cloud_types": {
      "items": {
        "$ref": "CloudTypeConfig
      }, 
      "required": false, 
      "title": "Cloud types list", 
      "type": "array"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud types list", 
  "type": "object"
}

CloudTypeInfo (type)

{
  "additionalProperties": false, 
  "id": "CloudTypeInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "cloud_type": {
      "description": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST", 
        "AZURE_GOV_US"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }
  }, 
  "title": "Cloud Type information", 
  "type": "object"
}

CloudUserInfo (type)

{
  "additionalProperties": false, 
  "id": "CloudUserInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Display name of the user", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the user", 
      "type": "string"
    }
  }, 
  "title": "User information", 
  "type": "object"
}

CloudVirtualMachine (type)

{
  "additionalProperties": false, 
  "description": "Stores information about a Virtual Machine", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CloudVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "agent_status": {
      "description": "UP - NSX Agent is up and running DOWN - NSX Agent is down NO_AGENT - No NSX Agent installed on instance UNKNOWN - NSX Agent status is unknown NEEDS_UPDATE - NSX Agent running on instance needs to be updated", 
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT", 
        "UNKNOWN", 
        "NEEDS_UPDATE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "cloud_instance_type": {
      "description": "This field represents various type of service instances in cloud. VIRTUAL_MACHINE: Virtual machine deployed in public cloud. AWS_RDS_INSTANCE: Amazon Relational Database Service Instance. AWS_RDS_CLUSTER: Amazon Relational Database Service Cluster. AWS_APPLICATION_ELB_INSTANCE: Amazon Application Elastic LoadBalancer. AWS_CLASSIC_ELB_INSTANCE: Amazon Classic Elastic LoadBalancer. HORIZON_MANAGEMENT: Virtual Machines that are deployed on Microsoft Azure using Horizon Cloud Services(HCS) that are used for managing other instances in the network. This includes, Management VMs, Unified Access Gateway (UAG) VMs, Base VMs. HORIZON_VDI: Virtual Desktop Image (VDI) deployed on Microsoft Azure using Horizon Cloud Services(HCS).", 
      "enum": [
        "VIRTUAL_MACHINE", 
        "AWS_RDS_INSTANCE", 
        "AWS_RDS_CLUSTER", 
        "AWS_APPLICATION_ELB_INSTANCE", 
        "AWS_CLASSIC_ELB_INSTANCE", 
        "HORIZON_MANAGEMENT", 
        "HORIZON_VDI"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Instance Type", 
      "type": "string"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the instance", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages identified in the last 1 hour.", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway.", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this instance is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if instance is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_failed_rules_count": {
      "description": "Number of NSX firewall rules failed to realize on cloud for the instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX failed rules count", 
      "type": "integer"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "nsx_security_group_mapping": {
      "description": "Map of cloud security groups associated to the instance and corresponding NSX security groups.", 
      "items": {
        "$ref": "SecurityGroupDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Group Mapping", 
      "type": "array"
    }, 
    "nsx_security_rule_errors": {
      "deprecated": true, 
      "description": "DEPRECATED. Array of NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "items": {
        "$ref": "NsxSecurityRuleErrorDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors", 
      "type": "array"
    }, 
    "nsx_security_rule_errors_count": {
      "deprecated": true, 
      "description": "DEPRECATED. Count of the NSX security rule realization errors. To get this information call /csm/virtual-machines/<virtual-machine-id>/firewall-rules", 
      "readonly": true, 
      "required": false, 
      "title": "NSX Security Rule Errors Count", 
      "type": "integer"
    }, 
    "nsx_successful_rules_count": {
      "description": "Number of NSX firewall rules successfully configured for this instance.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX successful rules count", 
      "type": "integer"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the instance", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the instance", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the instance", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the instance. QUARANTINED - This state implies instance is moved to quarantine security group because some threat has been detected. NOT_QUARANTINED - This state implies no quarantine action has been taken. UNKNOWN - This state implies either quarantine policy is disabled or quarantine information is not available. OVERRIDDEN - This state implies instance is associated with vm_override_sg which overrides any action based on threat detection. WHITELISTED - This state implies that quarantine operation will not be performed on the instance [DEPRECATED - replaced with USERMANAGED]. USERMANAGED - This state implies that quarantine operation will not be performed on the instance. NOT_APPLICABLE - This state will be populated for agentless instance, Horizon Management instance.", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN", 
        "WHITELISTED", 
        "USERMANAGED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of VirtualMachine prefixed by cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "segment_display_name": {
      "description": "Segment display name on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment display name", 
      "type": "string"
    }, 
    "segment_id": {
      "description": "Segment ID on which this instance resides.", 
      "readonly": true, 
      "required": false, 
      "title": "Segment ID", 
      "type": "string"
    }, 
    "status": {
      "description": "POWERED_ON - Powered on instance POWERED_OFF - Powered off instance MANAGED_GATEWAY - Instances that are public cloud gateways MANAGED - Instances that are managed by NSX UNMANAGED - Instances that are not managed by NSX or untagged ERRORED - Instances with no NSX Agent connectivity, NSX Agent is down, No NSX Policy configured for Agentless VMs or Error on NSX Policy rule realization. QUARANTINED - Instances which have been quarantined WHITELISTED - Instances which have been whitelisted [DEPRECATED - replaced with USERMANAGED] USERMANAGED - Instances which have been marked as usermanaged.", 
      "enum": [
        "POWERED_ON", 
        "POWERED_OFF", 
        "UNMANAGED", 
        "MANAGED_GATEWAY", 
        "MANAGED", 
        "ERRORED", 
        "QUARANTINED", 
        "WHITELISTED", 
        "USERMANAGED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Instance status", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the instance. NORMAL - This state implies no threat has been detected and instance is functioning as expected. THREAT - This state implies quarantine enabling threat has been detected. INVALID - This state implies either instance is unmanaged or threat related information is not available. NOT_APPLICABLE - This state will be populated for agentless instance.", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_config_status": {
      "$ref": "VmConfigStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Status for user configurable properties"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available           regarding extension execution. This can potentially occur for           a VM when agent is installed out of band or if           cloud_agent_automated_install_enabled flag is enabled for the           VNET/VPC which already has managed VMs. SUCCESSFUL - Indicates VM extension script execution was successful.           This does not necessarily mean agent installation was           successful. FAILED - Indicates VM extension script execution failed.", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machine Information", 
  "type": "object"
}

CloudVirtualMachinesListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list cloud virtual machines", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "CloudVirtualMachinesListRequestParameters", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which virtual machines are to be filtered", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "agent_status": {
      "description": "UP - NSX Agent is up and running DOWN - NSX Agent is down NO_AGENT - No NSX Agent installed on instance UNKNOWN - NSX Agent status is unknown UPDATE_AVAILABLE - NSX Tools can be upgraded to a newer version that's available NEEDS_UPDATE - NSX Tools running on the instance needs to be updated for proper functioning", 
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT", 
        "UNKNOWN", 
        "UPDATE_AVAILABLE", 
        "NEEDS_UPDATE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "cloud_security_group_id": {
      "description": "Optional identifier to limit results of VMs associated with the provided cloud security group. For AWS, provide the group id. For Azure, provide the resourceGuid of the Azure security group.", 
      "readonly": true, 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "cloud_type": {
      "description": "Optional identifier for cloud provider based on which Virtual Machines are to be filtered", 
      "enum": [
        "AWS", 
        "AZURE"
      ], 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "instance_id": {
      "description": "Optional identifier for virtual machine based on which the list can be filtered", 
      "required": false, 
      "title": "Instance ID", 
      "type": "string"
    }, 
    "is_gateway": {
      "description": "Optional identifier based on which only gateway Virtual Machines can be filtered", 
      "required": false, 
      "title": "Is the VM a gateway node?", 
      "type": "boolean"
    }, 
    "logical_switch_id": {
      "description": "Optional identifier for logical switch based on which Aws Virtual Machines are to be filtered", 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "public_ip": {
      "description": "Optional identifier for public IP based on which Virtual Machines are to be filtered", 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Identifier for quarantine state based on which Virtual Machines are to be filtered. QUARANTINED - This state implies instance is moved to quarantine security group because some threat has been detected. NOT_QUARANTINED - This state implies no quarantine action has been taken. UNKNOWN - This state implies either quarantine policy is disabled or quarantine information is not available. OVERRIDDEN - This state implies instance is associated with vm_override_sg which overrides any action based on threat detection.", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region_id": {
      "description": "Optional identifier for AWS or Azure region based on which Virtual Machines are to be filtered", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing virtual machines of a particular cloud provider. Possible values are in the form of VirtualMachine prefixed by cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "segment_id": {
      "description": "Optional identifier for segment based on which Virtual Machines are to be filtered.", 
      "required": false, 
      "title": "Segment ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status_filter": {
      "description": "POWERED_OFF - Powered off instances. MANAGED - Instances that are managed by NSX or tagged. UNMANAGED - Instances that are not managed by NSX or untagged. ERRORED - Instances with no NSX Tools connectivity, NSX Tools is down, No NSX Policy configured for Native cloud security enforced instances or Error on NSX Policy rule realization. WHITELISTED - Instances which have been marked allowed by NSX [DEPRECATED - replaced with USERMANAGED]. USERMANAGED - Instances which have been marked allowed by NSX. QUARANTINED - Instances that have been quarantined because some threat has been detected. NEEDS_UPDATE - NSX Tools running on instance is out of date and needs to be updated. HORIZON_VDI - Instances on Microsoft Azure that are part of the Horizon Cloud Services (HCS).", 
      "enum": [
        "POWERED_OFF", 
        "MANAGED", 
        "UNMANAGED", 
        "ERRORED", 
        "WHITELISTED", 
        "USERMANAGED", 
        "QUARANTINED", 
        "NEEDS_UPDATE", 
        "HORIZON_VDI"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Filter by Virtual machine status", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for Azure virtual network based on which Azure Virtual Machines are to be filtered. It consists of resourceGuid of Azure Vnet.", 
      "required": false, 
      "title": "Azure virtual network ID", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for AWS VPC based on which Virtual Machines are to be filtered", 
      "required": false, 
      "title": "AWS VPC ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machines List Request Parameters", 
  "type": "object"
}

CloudVirtualMachinesListResult (type)

{
  "additionalProperties": false, 
  "description": "Stores a list of cloud virtual machines", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CloudVirtualMachinesListResult", 
  "module_id": "CloudVirtualMachineInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of cloud virtual machines", 
      "items": {
        "$ref": "CloudVirtualMachine
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machines List Result", 
  "type": "object"
}

ClusterBackupInfo (type)

{
  "additionalProperties": false, 
  "id": "ClusterBackupInfo", 
  "module_id": "ClusterRestore", 
  "properties": {
    "ip_address": {
      "format": "hostname-or-ip", 
      "readonly": true, 
      "required": true, 
      "title": "IP address or FQDN of the node from which the backup was taken", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "ID of the node from which the backup was taken", 
      "type": "string"
    }, 
    "restore_type": {
      "default": [], 
      "items": {
        "enum": [
          "REGULAR_RESTORE", 
          "POLICY_ONLY_RESTORE"
        ], 
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Type of restore allowed", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": true, 
      "title": "timestamp of the cluster backup file"
    }
  }, 
  "title": "Cluster backup details", 
  "type": "object"
}

ClusterBackupInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterBackupInfoListResult", 
  "module_id": "ClusterRestore", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of timestamps of backed-up cluster files", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterCertificateId (type)

{
  "additionalProperties": false, 
  "id": "ClusterCertificateId", 
  "module_id": "ClusterCertificate", 
  "properties": {
    "certificate_id": {
      "required": true, 
      "title": "Certificate ID", 
      "type": "string"
    }
  }, 
  "title": "Cluster Certificate ID", 
  "type": "object"
}

ClusterConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RevisionedResource
  }, 
  "id": "ClusterConfig", 
  "module_id": "ClusterManagement", 
  "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"
    }, 
    "_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"
    }, 
    "cluster_id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique identifier of this cluster", 
      "type": "string"
    }, 
    "control_cluster_changes_allowed": {
      "title": "True if control cluster nodes may be added or removed", 
      "type": "boolean"
    }, 
    "mgmt_cluster_changes_allowed": {
      "title": "True if management cluster nodes may be added or removed", 
      "type": "boolean"
    }, 
    "nodes": {
      "items": {
        "$ref": "ClusterNodeInfo
      }, 
      "title": "Configuration of each node in cluster", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterConfiguration (type)

{
  "additionalProperties": false, 
  "description": "The configuration of the NSX cluster. The cluster configuration consists of a list of cluster node attributes.", 
  "id": "ClusterConfiguration", 
  "module_id": "Cluster", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "UUID of the cluster", 
      "type": "string"
    }, 
    "config_version": {
      "readonly": true, 
      "title": "Cluster configuration version", 
      "type": "integer"
    }, 
    "nodes": {
      "items": {
        "$ref": "ClusterNode
      }, 
      "readonly": true, 
      "title": "Nodes in the cluster configuration", 
      "type": "array"
    }
  }, 
  "title": "Cluster configuration", 
  "type": "object"
}

ClusterControlPlane (type)

{
  "description": "Cluster control plane is a hierarchical extension of the NSX-T control plane. It allows NSX to manage multiple clusters. There is an instance of cluster control plane in each managed cluster. The cluster control plane is responsible for the traffic management, span calculation and it can work on its own. NSX-T central control plane distributes high-level network configurations like security policies and groups to cluster control planes, and each cluster control plane computes and realizes the configurations on the managed cluster.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ClusterControlPlane", 
  "module_id": "ClusterControlPlane", 
  "policy_hierarchical_children": [
    "ChildAntreaClusterInfo", 
    "ChildAntreaHeartbeatConfig"
  ], 
  "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"
    }, 
    "certificate": {
      "description": "This property should be afford in create process.", 
      "required": false, 
      "title": "certificate for this cluster control plane", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "node_id": {
      "description": "This property is used to identify the cluster control plane in NSX-T. This id should assigned by NSX-T in create process.", 
      "required": false, 
      "title": "Unique Id of the cluster control plane", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "vhc_path": {
      "description": "This property should be afford in create process for VHC module requirement.", 
      "required": false, 
      "title": "vhc path for this cluster control plane", 
      "type": "string"
    }
  }, 
  "title": "Cluster Control Plane", 
  "type": "object"
}

ClusterControlPlaneDeleteRequestParameters (type)

{
  "description": "Cluster Control Plane delete request parameters.", 
  "id": "ClusterControlPlaneDeleteRequestParameters", 
  "module_id": "ClusterControlPlane", 
  "properties": {
    "cascade": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate if force delete cluster references from the firewall security policies.", 
      "type": "boolean"
    }
  }, 
  "title": "Cluster Control Plane Delete Request Parameters", 
  "type": "object"
}

ClusterControlPlaneListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Cluster Control Plane list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ClusterControlPlaneListRequestParameters", 
  "module_id": "ClusterControlPlane", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cluster Control Plane List Request Parameters", 
  "type": "object"
}

ClusterControlPlaneListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterControlPlaneListResult", 
  "module_id": "ClusterControlPlane", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "This property include all cluster control Plane in NSX-T.", 
      "items": {
        "$ref": "ClusterControlPlane
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cluster Control Plane Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cluster Control Plane queries result", 
  "type": "object"
}

ClusterDpuConfig (type)

{
  "description": "Specifies configuration of a homogeneous cluster. If this property is set for a cluster, which indicate that this is a homogenous cluster consisting of hosts running ESXio on data processing unit (DPU) from a certain vendor.", 
  "id": "ClusterDpuConfig", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "vendor": {
      "description": "Specifies the vendor of the data processing unit.", 
      "readonly": true, 
      "required": false, 
      "title": "Vendor of DPU", 
      "type": "string"
    }
  }, 
  "title": "Configuration of homogeneous cluster", 
  "type": "object"
}

ClusterGroupMemberStatus (type)

{
  "additionalProperties": false, 
  "description": "This type contains the attributes and status of a group member.", 
  "id": "ClusterGroupMemberStatus", 
  "module_id": "Cluster", 
  "properties": {
    "member_fqdn": {
      "format": "hostname", 
      "readonly": true, 
      "title": "FQDN of the group member", 
      "type": "string"
    }, 
    "member_ip": {
      "format": "ip", 
      "readonly": true, 
      "title": "IP of the group member", 
      "type": "string"
    }, 
    "member_ipv6": {
      "format": "ip", 
      "readonly": true, 
      "title": "IPv6 of the group member", 
      "type": "string"
    }, 
    "member_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Status of the group member", 
      "type": "string"
    }, 
    "member_uuid": {
      "readonly": true, 
      "title": "UUID of the group member", 
      "type": "string"
    }
  }, 
  "title": "Status of a group member", 
  "type": "object"
}

ClusterGroupServiceLeader (type)

{
  "additionalProperties": false, 
  "description": "Each cluster node entity provides multiple services. When working in a group, each service can elect a cluster node entity to be the leader of the service. Leader election helps in coordination of the service. The leader holds a renewable lease on the leadership for a fixed period of time. The lease version is incremented every time the leadership lease is renewed. This type contains the attributes of a leader.", 
  "id": "ClusterGroupServiceLeader", 
  "module_id": "Cluster", 
  "properties": {
    "leader_uuid": {
      "readonly": true, 
      "title": "Member UUID of the leader", 
      "type": "string"
    }, 
    "lease_version": {
      "readonly": true, 
      "title": "Number of times the lease has been renewed", 
      "type": "integer"
    }, 
    "service_name": {
      "readonly": true, 
      "title": "Name of the service", 
      "type": "string"
    }
  }, 
  "title": "Leader for a service of the group", 
  "type": "object"
}

ClusterGroupStatus (type)

{
  "additionalProperties": false, 
  "description": "This type contains the attributes and status of a group.", 
  "id": "ClusterGroupStatus", 
  "module_id": "Cluster", 
  "properties": {
    "group_id": {
      "readonly": true, 
      "title": "UUID of the group", 
      "type": "string"
    }, 
    "group_status": {
      "enum": [
        "STABLE", 
        "DEGRADED", 
        "UNSTABLE", 
        "UNAVAILABLE"
      ], 
      "readonly": true, 
      "title": "Group status", 
      "type": "string"
    }, 
    "group_type": {
      "enum": [
        "MANAGER", 
        "CONTROLLER", 
        "POLICY", 
        "HTTPS", 
        "DATASTORE", 
        "CLUSTER_BOOT_MANAGER", 
        "GLOBAL_MANAGER", 
        "ASYNC_REPLICATOR", 
        "MONITORING", 
        "IDPS_REPORTING", 
        "CORFU_NONCONFIG", 
        "CM-INVENTORY", 
        "MESSAGING-MANAGER"
      ], 
      "readonly": true, 
      "title": "Type of the group", 
      "type": "string"
    }, 
    "leaders": {
      "items": {
        "$ref": "ClusterGroupServiceLeader
      }, 
      "readonly": true, 
      "title": "Array of group leaders and their attributes", 
      "type": "array"
    }, 
    "members": {
      "items": {
        "$ref": "ClusterGroupMemberStatus
      }, 
      "readonly": true, 
      "title": "Array of group members and their statuses", 
      "type": "array"
    }
  }, 
  "title": "Status of a group", 
  "type": "object"
}

ClusterInitializationNodeInfo (type)

{
  "additionalProperties": false, 
  "description": "The type provides the information of a non-running cluster node required for the initialization of a management cluster. The administrator needs to start this node for management cluster to initialize properly (or decommission it explicitly).", 
  "id": "ClusterInitializationNodeInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "disk_store_id": {
      "readonly": true, 
      "required": false, 
      "title": "The (internal) disk-store ID of the member", 
      "type": "string"
    }, 
    "host_address": {
      "readonly": true, 
      "title": "The IP address (or domain name) of the cluster node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterMemberDetails (type)

{
  "additionalProperties": false, 
  "description": "Details of the member belonging to a Group", 
  "id": "ClusterMemberDetails", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "required": true, 
      "title": "The Antrea cluster id of the pod", 
      "type": "string"
    }, 
    "cluster_name": {
      "readonly": true, 
      "required": true, 
      "title": "The Antrea cluster name of the pod", 
      "type": "string"
    }, 
    "namespaces": {
      "items": {
        "$ref": "NamespaceMemberDetails
      }, 
      "required": true, 
      "type": "array"
    }
  }, 
  "title": "Group member details", 
  "type": "object"
}

ClusterNode (type)

{
  "additionalProperties": false, 
  "description": "This type contains attributes of a cluster node that are relevant to the Cluster Boot Manager.", 
  "id": "ClusterNode", 
  "module_id": "Cluster", 
  "properties": {
    "entities": {
      "items": {
        "$ref": "ClusterNodeEntity
      }, 
      "required": true, 
      "title": "Entities on the node", 
      "type": "array"
    }, 
    "node_uuid": {
      "required": true, 
      "title": "UUID of the node", 
      "type": "string"
    }, 
    "status": {
      "default": "REMOVED", 
      "enum": [
        "JOINING", 
        "JOINED", 
        "REMOVING", 
        "REMOVED"
      ], 
      "title": "Current clustering status of the node", 
      "type": "string"
    }
  }, 
  "title": "Cluster Node Properties", 
  "type": "object"
}

ClusterNodeConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ClusterNodeConfig", 
  "module_id": "ClusterManagement", 
  "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"
    }, 
    "appliance_mgmt_ipv6_listen_addr": {
      "readonly": true, 
      "title": "The IPv6 address for the appliance management API service on this node", 
      "type": "string"
    }, 
    "appliance_mgmt_listen_addr": {
      "readonly": true, 
      "title": "The IP and port for the appliance management API service on this node", 
      "type": "string"
    }, 
    "controller_role": {
      "$ref": "ControllerClusterRoleConfig, 
      "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"
    }, 
    "external_id": {
      "readonly": true, 
      "title": "Internal identifier provided by the node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "manager_role": {
      "$ref": "ManagementClusterRoleConfig, 
      "required": false
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterNodeConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterNodeConfigListResult", 
  "module_id": "ClusterManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterNodeConfig
      }, 
      "required": true, 
      "title": "Cluster node configuration results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeEntity (type)

{
  "additionalProperties": false, 
  "description": "NSX Cluster is made up of multiple cluster nodes. Each node can perform multiple functions, commonly referred to as roles. Cluster node entities are processes running in a cluster node that assist in the performance of a role. Cluster Boot Manager is a daemon that securely bootstraps and configures the entities. This type contains attributes of a cluster node entity that are relevant to the Cluster Boot Manager.", 
  "id": "ClusterNodeEntity", 
  "module_id": "Cluster", 
  "properties": {
    "certificate": {
      "required": true, 
      "title": "Public certificate of the entity in PEM format", 
      "type": "string"
    }, 
    "entity_type": {
      "enum": [
        "MANAGER", 
        "CONTROLLER", 
        "POLICY", 
        "HTTPS", 
        "CLUSTER_BOOT_MANAGER", 
        "DATASTORE", 
        "GLOBAL_MANAGER", 
        "ASYNC_REPLICATOR", 
        "MONITORING", 
        "IDPS_REPORTING", 
        "CORFU_NONCONFIG", 
        "UPGRADE_COORDINATOR", 
        "CM-INVENTORY", 
        "MESSAGING-MANAGER"
      ], 
      "required": true, 
      "title": "Type of the entity", 
      "type": "string"
    }, 
    "entity_uuid": {
      "required": true, 
      "title": "UUID of the entity", 
      "type": "string"
    }, 
    "fqdn": {
      "format": "hostname", 
      "required": false, 
      "title": "Domain name the entity binds to", 
      "type": "string"
    }, 
    "ip_address": {
      "required": false, 
      "title": "IP address the entity binds to", 
      "type": "string"
    }, 
    "ipv6_address": {
      "required": false, 
      "title": "IPv6 address the entity binds to", 
      "type": "string"
    }, 
    "ipv6_subnet_prefix_length": {
      "maximum": 128, 
      "minimum": 0, 
      "required": false, 
      "title": "IPv6 subnet mask prefix length of the entity binds to", 
      "type": "integer"
    }, 
    "port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port the entity binds to", 
      "type": "integer"
    }, 
    "subnet_prefix_length": {
      "maximum": 32, 
      "minimum": 0, 
      "required": false, 
      "title": "Subnet mask prefix length of the entity binds to", 
      "type": "integer"
    }
  }, 
  "title": "Cluster Node Entity Properties", 
  "type": "object"
}

ClusterNodeInfo (type)

{
  "id": "ClusterNodeInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "api_listen_addr": {
      "$ref": "ServiceEndpoint, 
      "readonly": true, 
      "title": "The IP and port for the public API service on this node"
    }, 
    "appliance_connection_info": {
      "$ref": "ServiceEndpoint, 
      "readonly": true, 
      "title": "The IP, port and certificate for connecting to appliance."
    }, 
    "certificates": {
      "items": {
        "$ref": "NodeCertificateInfo
      }, 
      "title": "Certificate and thumbprint of all entities", 
      "type": "array"
    }, 
    "control_plane_listen_addr": {
      "$ref": "ServiceEndpoint, 
      "readonly": true, 
      "title": "The IP and port for the control plane service on this node"
    }, 
    "display_name": {
      "title": "The display name of this node", 
      "type": "string"
    }, 
    "entities": {
      "items": {
        "$ref": "NodeEntityInfo
      }, 
      "title": "Service endpoint of all entities", 
      "type": "array"
    }, 
    "fqdn": {
      "title": "The fqdn of this node", 
      "type": "string"
    }, 
    "msg_clients": {
      "items": {
        "$ref": "NodeMessagingClientInfo
      }, 
      "title": "Messaging client of all entities", 
      "type": "array"
    }, 
    "node_uuid": {
      "readonly": true, 
      "required": true, 
      "title": "Unique identifier of this node", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "JOINING", 
        "JOINED", 
        "REMOVING", 
        "REMOVED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Node clustering status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeRole (type)

{
  "description": "Enumerates the roles that can be specified in VM auto-deployment.", 
  "enum": [
    "CONTROLLER", 
    "MANAGER"
  ], 
  "id": "ClusterNodeRole", 
  "module_id": "ClusterNodeVMDeployment", 
  "title": "Cluster node role", 
  "type": "string"
}

ClusterNodeStatus (type)

{
  "additionalProperties": false, 
  "id": "ClusterNodeStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_status": {
      "$ref": "ControlClusterNodeStatus, 
      "readonly": true, 
      "title": "Clustering status for control plane functions on this node"
    }, 
    "mgmt_cluster_status": {
      "$ref": "ManagementClusterNodeStatus, 
      "readonly": true, 
      "title": "Clustering status for management plane functions on this node"
    }, 
    "system_status": {
      "$ref": "NodeStatusProperties, 
      "readonly": true, 
      "title": "Node status properties"
    }, 
    "version": {
      "readonly": true, 
      "title": "Software version running on node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeVMDeletionParameters (type)

{
  "description": "Parameters for deletion of a cluster node VM.", 
  "id": "ClusterNodeVMDeletionParameters", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "force_delete": {
      "description": "If true, the VM will be undeployed even if it cannot be removed from its cluster.", 
      "title": "Delete by force", 
      "type": "boolean"
    }
  }, 
  "title": "Parameters for DeleteAutoDeployedClusterNodeVM", 
  "type": "object"
}

ClusterNodeVMDeploymentConfig (type)

{
  "description": "Contains info used to configure the VM on deployment", 
  "id": "ClusterNodeVMDeploymentConfig", 
  "module_id": "ClusterNodeVMDeployment", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "placement_type"
  }, 
  "properties": {
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the VM", 
      "enum": [
        "VsphereClusterNodeVMDeploymentConfig"
      ], 
      "required": true, 
      "title": "Type of deployment", 
      "type": "string"
    }
  }, 
  "title": "Configuration for deploying cluster node VM", 
  "type": "object"
}

ClusterNodeVMDeploymentRequest (type)

{
  "additionalProperties": false, 
  "description": "Contains the deployment information for a cluster node VM soon to be deployed or already deployed by the Manager", 
  "id": "ClusterNodeVMDeploymentRequest", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "deployment_config": {
      "$ref": "ClusterNodeVMDeploymentConfig, 
      "description": "Info needed to configure a cluster node VM at deployment for a specific platform. May require different parameters depending on the method used to deploy the VM.", 
      "required": true, 
      "title": "Deployment config for cluster node VM"
    }, 
    "form_factor": {
      "$ref": "ClusterNodeVMFormFactor, 
      "default": "MEDIUM", 
      "description": "Specifies the desired \"size\" of the VM", 
      "required": false, 
      "title": "Form factor for cluster node VMs"
    }, 
    "roles": {
      "description": "List of cluster node role (or roles) which the VM should take on. They specify what type (or types) of cluster node which the new VM should act as. Currently both CONTROLLER and MANAGER must be provided, since this permutation is the only one supported now.", 
      "items": {
        "$ref": "ClusterNodeRole
      }, 
      "required": true, 
      "title": "Cluster node roles of the VM", 
      "type": "array"
    }, 
    "user_settings": {
      "$ref": "NodeUserSettings, 
      "description": "Username and password settings for the cluster node VM. Passwords must be at least 12 characters in length and contain at least one lowercase, one uppercase, one numerical, and one special character. Note: These settings will be honored only during VM deployment. Post-deployment, CLI must be used for changing the user settings and changes to these parameters will not have any effect.", 
      "required": true, 
      "sensitive": true, 
      "title": "User settings for the VM"
    }, 
    "vm_id": {
      "description": "ID of the VM maintained internally and used to recognize it. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of VM used to recognize it", 
      "type": "string"
    }
  }, 
  "title": "Info for an auto-deployment request", 
  "type": "object"
}

ClusterNodeVMDeploymentRequestList (type)

{
  "additionalProperties": false, 
  "description": "List of ClusterNodeVMDeploymentRequests", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterNodeVMDeploymentRequestList", 
  "module_id": "ClusterNodeVMDeployment", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of existing ClusterNodeVMDeploymentRequests", 
      "items": {
        "$ref": "ClusterNodeVMDeploymentRequest
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ClusterNodeVMDeploymentRequest list", 
  "type": "object"
}

ClusterNodeVMDeploymentStatusReport (type)

{
  "description": "Contains up-to-date information relating to an auto-deployed VM, including its status and (potentially) an error message.", 
  "id": "ClusterNodeVMDeploymentStatusReport", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "deployment_progress_state": {
      "$ref": "VMDeploymentProgressState, 
      "description": "Detailed progress state of node VM deployment realization", 
      "readonly": true, 
      "required": false, 
      "title": "Deployment progress state of node VM"
    }, 
    "failure_code": {
      "description": "In case of auto-deployment-related failure, the code for the error will be stored here.", 
      "required": false, 
      "title": "Error code for failure", 
      "type": "integer"
    }, 
    "failure_message": {
      "description": "In case of auto-deployment-related failure, an error message will be stored here.", 
      "required": false, 
      "title": "Error message for failure", 
      "type": "string"
    }, 
    "status": {
      "description": "Status of the addition or deletion of an auto-deployed cluster node VM.", 
      "enum": [
        "UNKNOWN_STATE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "WAITING_TO_REGISTER_VM", 
        "VM_REGISTRATION_FAILED", 
        "VM_WAITING_TO_CLUSTER", 
        "VM_WAITING_TO_COME_ONLINE", 
        "VM_ONLINE_FAILED", 
        "VM_CLUSTERING_IN_PROGRESS", 
        "VM_CLUSTERING_FAILED", 
        "VM_CLUSTERING_SUCCESSFUL", 
        "WAITING_TO_UNDEPLOY_VM", 
        "VM_DECLUSTER_IN_PROGRESS", 
        "VM_DECLUSTER_FAILED", 
        "VM_DECLUSTER_SUCCESSFUL", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL"
      ], 
      "required": true, 
      "title": "Auto-deployed VM's deployment status", 
      "type": "string"
    }
  }, 
  "title": "Report of a VM's deployment status", 
  "type": "object"
}

ClusterNodeVMFormFactor (type)

{
  "description": "Specifies the desired \"size\" of the VM. Affects number of virtual CPUs and/or memory size given to the new cluster node VM.", 
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE"
  ], 
  "id": "ClusterNodeVMFormFactor", 
  "module_id": "ClusterNodeVMDeployment", 
  "title": "Supported VM form factor for cluster nodes", 
  "type": "string"
}

ClusterProfile (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ClusterProfile", 
  "module_id": "ClusterProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterProfileListParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ClusterProfileListParameters", 
  "module_id": "ClusterProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_system_owned": {
      "default": true, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType, 
      "required": false, 
      "title": "Type of cluster profile"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ClusterProfile List Parameters", 
  "type": "object"
}

ClusterProfileListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterProfileListResult", 
  "module_id": "ClusterProfile", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterProfile
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cluster Profile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cluster Profile queries result", 
  "type": "object"
}

ClusterProfileType (type)

{
  "enum": [
    "EdgeHighAvailabilityProfile", 
    "BridgeHighAvailabilityClusterProfile"
  ], 
  "id": "ClusterProfileType", 
  "module_id": "ClusterProfile", 
  "title": "Supported cluster profiles.", 
  "type": "string"
}

ClusterProfileTypeIdEntry (type) (Deprecated)

{
  "deprecated": true, 
  "id": "ClusterProfileTypeIdEntry", 
  "module_id": "ClusterProfile", 
  "properties": {
    "profile_id": {
      "description": "key value", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType
    }
  }, 
  "type": "object"
}

ClusterRestoreStatus (type)

{
  "id": "ClusterRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "backup_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when backup was initiated in epoch millisecond"
    }, 
    "endpoints": {
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "required": true, 
      "title": "The list of allowed endpoints, based on the current state of\nthe restore process\n", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "Unique id for backup request", 
      "type": "string"
    }, 
    "instructions": {
      "items": {
        "$ref": "InstructionInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Instructions for users to reconcile Restore operations", 
      "type": "array"
    }, 
    "not_allowed_actions": {
      "default": [], 
      "items": {
        "enum": [
          "VC_UPDATES"
        ], 
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of actions that are not allowed", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "restore_end_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was completed in epoch millisecond"
    }, 
    "restore_start_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was started in epoch millisecond"
    }, 
    "status": {
      "$ref": "GlobalRestoreStatus
    }, 
    "step": {
      "$ref": "RestoreStep
    }, 
    "total_steps": {
      "readonly": true, 
      "required": false, 
      "title": "Total number of steps in the entire restore process", 
      "type": "integer"
    }
  }, 
  "title": "Cluster restore status", 
  "type": "object"
}

ClusterRestoreStatusRequestParameters (type)

{
  "id": "ClusterRestoreStatusRequestParameters", 
  "properties": {
    "restore_component": {
      "default": "LOCAL_MANAGER", 
      "enum": [
        "LOCAL_MANAGER", 
        "GLOBAL_MANAGER"
      ], 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterRoleConfig (type)

{
  "additionalProperties": false, 
  "id": "ClusterRoleConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "type": {
      "enum": [
        "ManagementClusterRoleConfig", 
        "ControllerClusterRoleConfig"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of this role configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterStatus (type)

{
  "additionalProperties": false, 
  "id": "ClusterStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "Unique identifier of this cluster", 
      "type": "string"
    }, 
    "control_cluster_status": {
      "$ref": "ControllerClusterStatus, 
      "deprecated": true, 
      "readonly": true, 
      "title": "The current status of the control cluster"
    }, 
    "detailed_cluster_status": {
      "$ref": "AllClusterGroupStatus, 
      "readonly": true, 
      "title": "Status of all the cluster groups"
    }, 
    "mgmt_cluster_status": {
      "$ref": "ManagementClusterStatus, 
      "deprecated": true, 
      "readonly": true, 
      "title": "The current status of the management cluster"
    }
  }, 
  "type": "object"
}

ClusterVirtualIpProperties (type)

{
  "additionalProperties": false, 
  "id": "ClusterVirtualIpProperties", 
  "properties": {
    "force": {
      "default": "false", 
      "enum": [
        "true", 
        "false"
      ], 
      "title": "On enable it ignores duplicate address detection and DNS lookup validation check", 
      "type": "string"
    }, 
    "ip6_address": {
      "title": "Virtual IPv6 address, :: if not configured", 
      "type": "string"
    }, 
    "ip_address": {
      "title": "Virtual IP address, 0.0.0.0 if not configured", 
      "type": "string"
    }
  }, 
  "title": "Cluster virtual IP properties", 
  "type": "object"
}

ClusteringConfig (type)

{
  "description": "Configuration for automatically joining a cluster node to the cluster after it is deployed. ClusteringConfig is required if any of the deployment nodes has CONTROLLER role.", 
  "id": "ClusteringConfig", 
  "module_id": "ClusterNodeVMDeployment", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "clustering_type"
  }, 
  "properties": {
    "clustering_type": {
      "description": "Specifies the type of clustering config to be used.", 
      "enum": [
        "ControlClusteringConfig"
      ], 
      "required": true, 
      "title": "Type for the clustering config", 
      "type": "string"
    }
  }, 
  "title": "Configuration for VM's clustering", 
  "type": "object"
}

ClusteringInfo (type)

{
  "description": "Clustering parameters for the controller cluster", 
  "id": "ClusteringInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "join_to_existing_cluster": {
      "description": "Property to indicate if the node must join an existing cluster.", 
      "required": true, 
      "title": "True If the controller node should join an existing cluster", 
      "type": "boolean"
    }, 
    "shared_secret": {
      "description": "Shared secret of the cluster.", 
      "required": true, 
      "sensitive": true, 
      "title": "Shared Secret of the cluster", 
      "type": "secure_string"
    }
  }, 
  "type": "object"
}

ClusteringStatus (type)

{
  "enum": [
    "CONNECTED", 
    "DISCONNECTED", 
    "UNKNOWN"
  ], 
  "id": "ClusteringStatus", 
  "module_id": "ClusterManagement", 
  "type": "string"
}

ClustersAggregateInfo (type)

{
  "additionalProperties": false, 
  "id": "ClustersAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cluster_status": {
      "$ref": "AllClusterGroupStatus, 
      "title": "Status of all the cluster groups"
    }, 
    "controller_cluster": {
      "items": {
        "$ref": "ControllerNodeAggregateInfo
      }, 
      "required": true, 
      "title": "Array of Controller Nodes", 
      "type": "array"
    }, 
    "management_cluster": {
      "items": {
        "$ref": "ManagementNodeAggregateInfo
      }, 
      "required": true, 
      "title": "Array of Management Nodes", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CmThumbprintHashingConfig (type)

{
  "additionalProperties": false, 
  "id": "CmThumbprintHashingConfig", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "hashing_algorithm_type": {
      "description": "This specifies the hashing algorithm to be used for stamping NSX manager thumbprint in compute manager extension. e.g. When a vCenter is registered as compute manager, thumbprint of NSX manager certificate is stamped in NSXT extension on vCenter. If algorithm type is SHA1, then SHA1 thumbprint of NSX manager API certificate is stamped. If algorithm type is SHA256, then SHA256 thumbprint of NSX manager certificate is stamped. Changing this setting to SHA256 will result in communication issues between WCP component in VC and NSX manager. Hence it is recommended not to use SHA256 if VC WCP feature is being used with NSX.", 
      "enum": [
        "SHA1", 
        "SHA256"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Algorithm type for thumbprint hashing", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ColumnItem (type)

{
  "additionalProperties": false, 
  "description": "Represents a column of the Grid", 
  "id": "ColumnItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "column_identifier": {
      "description": "Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.", 
      "title": "Identifier for this column", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "Field from which values of the column will be derived.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Column Field", 
      "type": "string"
    }, 
    "hidden": {
      "default": false, 
      "description": "If set to true, hides the column", 
      "title": "Hide the column", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Label of the column.", 
      "readonly": false, 
      "required": true, 
      "title": "Column Label"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Render configuration to be applied, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "sort_ascending": {
      "default": true, 
      "description": "If true, the value of the column are sorted in ascending order. Otherwise, in descending order.", 
      "title": "Represents order of sorting the values", 
      "type": "boolean"
    }, 
    "sort_key": {
      "description": "Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.", 
      "maxLength": 255, 
      "title": "Key for sorting on this column", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over a cell in the grid.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "type": {
      "default": "String", 
      "description": "Data type of the field.", 
      "enum": [
        "String", 
        "Number", 
        "Date"
      ], 
      "maxLength": 255, 
      "required": true, 
      "title": "Field data type", 
      "type": "string"
    }
  }, 
  "title": "Grid Column", 
  "type": "object"
}

CommonAgentEndpointInfo (type)

{
  "description": "An endpoint to connect to Kafka/ingress of the NSX Application Platform. Either FQDN or IP address can be used in the endpoint info.", 
  "id": "CommonAgentEndpointInfo", 
  "module_id": "PolicyCloudNativeCommonAgent", 
  "properties": {
    "address": {
      "description": "The IP address or the full qualified domain name of Kafka broker/ingress.", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "address", 
      "type": "string"
    }, 
    "port": {
      "description": "The port number where the broker is listening to.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "port number", 
      "type": "integer"
    }
  }, 
  "title": "NSX Application Platform Kafka/ingress endpoints", 
  "type": "object"
}

CommonAgentHostConfigurationInfo (type)

{
  "description": "NSX Application Platform Common Agent configuration that can be applied to host nodes.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CommonAgentHostConfigurationInfo", 
  "module_id": "PolicyCloudNativeCommonAgent", 
  "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"
    }, 
    "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"
    }, 
    "ingress_certificate": {
      "description": "A ingress certificate to verify the identity of brokers.", 
      "required": false, 
      "title": "Broker certificate", 
      "type": "string"
    }, 
    "ingress_endpoint": {
      "description": "List of NSX Application Platform ingress endpoints that host nodes contact initially.", 
      "items": {
        "$ref": "CommonAgentEndpointInfo
      }, 
      "required": false, 
      "title": "List of NSX Application Platform ingress endpoints", 
      "type": "array"
    }, 
    "kafka_certificate": {
      "description": "A Kafka broker certificate to verify the identity of brokers.", 
      "required": false, 
      "title": "Broker certificate", 
      "type": "string"
    }, 
    "kafka_endpoint": {
      "description": "List of NSX Application Platform broker endpoints that host nodes contact initially.", 
      "items": {
        "$ref": "CommonAgentEndpointInfo
      }, 
      "required": false, 
      "title": "List of NSX Application Platform Kafka broker endpoints", 
      "type": "array"
    }, 
    "nsx_cluster_id": {
      "description": "Cluster id of the NSX Manager cluster.", 
      "required": false, 
      "title": "Cluster id of the NSX Manager cluster", 
      "type": "string"
    }, 
    "private_ip_range": {
      "description": "List of private IP prefix that NSX Application Platform Common Agent network flow is collected from.", 
      "items": {
        "$ref": "CommonAgentPrivateIpRangeInfo
      }, 
      "required": false, 
      "title": "List of private IP prefix", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "site_id": {
      "description": "Site id of the local manager.", 
      "required": false, 
      "title": "Site id of the local manager", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "truststore": {
      "description": "A truststore to establish the trust between NSX and NSX Application Platform.", 
      "required": false, 
      "title": "truststore", 
      "type": "string"
    }
  }, 
  "title": "NSX Application Platform Common Agent host configuration", 
  "type": "object"
}

CommonAgentPrivateIpRangeInfo (type)

{
  "description": "An IP prefix to mark the private network that NSX Application Platform Common Agent network flow is collected from.", 
  "id": "CommonAgentPrivateIpRangeInfo", 
  "module_id": "PolicyCloudNativeCommonAgent", 
  "properties": {
    "address": {
      "$ref": "IPAddress, 
      "description": "The prefix of IP address that marks the range of private network.", 
      "required": true, 
      "title": "IP address"
    }, 
    "address_type": {
      "description": "The type of IP address.", 
      "enum": [
        "IPV4", 
        "IPV6"
      ], 
      "required": true, 
      "title": "IP address type", 
      "type": "string"
    }, 
    "prefix_length": {
      "description": "The length of IP address prefix that marks the range of private network.", 
      "maximum": 128, 
      "minimum": 1, 
      "required": true, 
      "title": "IP prefix length", 
      "type": "integer"
    }
  }, 
  "title": "NSX Application Platform Common Agent private IP prefix", 
  "type": "object"
}

CommonUploadFile (type)

{
  "additionalProperties": false, 
  "description": "To upload file content example kubeconfig or Kubernetes tools.", 
  "extends": {
    "$ref": "NoRestRequestParameters
  }, 
  "id": "CommonUploadFile", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "file": {
      "description": "Kubeconfig or Kubernetes tools file to be imported.", 
      "required": true, 
      "title": "File to upload", 
      "type": "multipart_file"
    }
  }, 
  "title": "To upload kubeconfig or Kubernetes tools", 
  "type": "object"
}

CommunicationEntry (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A communication entry indicates the action to be performed for various types of traffic flowing between workload groups. This type is deprecated. Use the type Rule instead.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunicationEntry", 
  "module_id": "Policy", 
  "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": "The action to be applied to all the services.", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT"
      ], 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number", 
      "required": false, 
      "title": "Sequence number of the this CommunicationEntry", 
      "type": "int"
    }, 
    "services": {
      "description": "In order to specify all services, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "required": false, 
      "title": "Tag applied on the communication entry", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "A communication entry specifies the security policy between the workload groups", 
  "type": "object"
}

CommunicationEntryInsertParameters (type) (Deprecated)

{
  "deprecated": true, 
  "description": "Parameters to let the admin specify a relative position of a communication entry w.r.t to another one in the same communication map. If the communication entry specified in the anchor_path belongs to another communication map an error will be thrown This type is deprecated. Use the type RuleInsertParameters instead.", 
  "extends": {
    "$ref": "CommunicationInsertParameters
  }, 
  "id": "CommunicationEntryInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The communication map/communication entry path if operation is\n'insert_after' or 'insert_before'\n", 
      "type": "string"
    }, 
    "operation": {
      "default": "insert_top", 
      "enum": [
        "insert_top", 
        "insert_bottom", 
        "insert_after", 
        "insert_before"
      ], 
      "required": false, 
      "title": "Operation", 
      "type": "string"
    }
  }, 
  "title": "Parameters to tell where communication entry needs to be placed", 
  "type": "object"
}

CommunicationEntryListRequestParameters (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "This type is deprecated. Use the type RuleListRequestParameters instead.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "CommunicationEntryListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CommunicationEntry list request parameters", 
  "type": "object"
}

CommunicationEntryListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "This type is deprecated. Use the type RuleListResult instead.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CommunicationEntryListResult", 
  "module_id": "Policy", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CommunicationEntry
      }, 
      "required": true, 
      "title": "CommunicationEntry list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of CommunicationEntries", 
  "type": "object"
}

CommunicationInsertParameters (type) (Deprecated)

{
  "deprecated": true, 
  "description": "Parameters to let the admin specify a relative position of a communication map or communication entry w.r.t to another one. This type is deprecated. Use the type RuleInsertParameters instead.", 
  "id": "CommunicationInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The communication map/communication entry path if operation is\n'insert_after' or 'insert_before'\n", 
      "type": "string"
    }, 
    "operation": {
      "default": "insert_top", 
      "enum": [
        "insert_top", 
        "insert_bottom", 
        "insert_after", 
        "insert_before"
      ], 
      "required": false, 
      "title": "Operation", 
      "type": "string"
    }
  }, 
  "title": "Parameters to tell where communication map/communication entry\nneeds to be placed\n", 
  "type": "object"
}

CommunicationMap (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Ordered list of CommunicationEntries. This object is created by default along with the Domain. This type is deprecated. Use the type SecurityPolicy instead.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunicationMap", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildCommunicationEntry"
  ], 
  "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"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework for Distributed Firewall provides four pre-defined categories for classifying a communication map. They are \"Emergency\", \"Infrastructure\", \"Environment\" and \"Application\". Amongst the layer 3 communication maps,there is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a communication  map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four layer 3 categories.", 
      "required": false, 
      "title": "A way to classify a communication map, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "communication_entries": {
      "items": {
        "$ref": "CommunicationEntry
      }, 
      "required": false, 
      "title": "CommunicationEntries that are a part of this CommunicationMap", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "precedence": {
      "description": "This field is used to resolve conflicts between communication maps across domains. In order to change the precedence of a communication map one can fire a POST request on the communication map entity with a query parameter action=revise The precedence field will reflect the value of the computed precedence upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several communication maps, the only way to set the precedence is to explicitly specify the precedence number for each communication map. If no precedence is specified in the payload, a value of 0 is assigned by default. If there are multiple communication maps with the same precedence then their order is not deterministic. If a specific order of communication map is desired, then one has to specify a unique precedence or use the POST request on the communication map entity with a query parameter action=revise to let the framework assign a precedence", 
      "title": "Precedence to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Contains ordered list of CommunicationEntries", 
  "type": "object"
}

CommunicationMapInsertParameters (type) (Deprecated)

{
  "deprecated": true, 
  "description": "Parameters to let the admin specify a relative position of a communication map w.r.t to another one. This type is deprecated. Use the type SecurityPolicyInsertParameters instead.", 
  "extends": {
    "$ref": "CommunicationInsertParameters
  }, 
  "id": "CommunicationMapInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The communication map/communication entry path if operation is\n'insert_after' or 'insert_before'\n", 
      "type": "string"
    }, 
    "operation": {
      "default": "insert_top", 
      "enum": [
        "insert_top", 
        "insert_bottom", 
        "insert_after", 
        "insert_before"
      ], 
      "required": false, 
      "title": "Operation", 
      "type": "string"
    }
  }, 
  "title": "Parameters to tell where communication map needs to be placed", 
  "type": "object"
}

CommunicationMapListRequestParameters (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "This type is deprecated. Use the type SecurityPolicyListRequestParameters instead.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "CommunicationMapListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CommunicationMap list request parameters", 
  "type": "object"
}

CommunicationMapListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "This type is deprecated. Use the type SecurityPolicyListResult instead.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CommunicationMapListResult", 
  "module_id": "Policy", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CommunicationMap
      }, 
      "required": true, 
      "title": "CommunicationMap list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Communication map", 
  "type": "object"
}

CommunityList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunityList", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "communities": {
      "description": "List of BGP community entries. Both standard and large communities are supported. Standard community format: aa:nn where aa and nn must be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn where aa (Global Administrator), bb  (Local Data Part 1) and nn (Local Data Part 2) must be within the range [1 - 4294967295]. In additon to numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of BGP community entries", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Community list for BGP routing configuration", 
  "type": "object"
}

CommunityListListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CommunityListListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CommunityList
      }, 
      "required": true, 
      "title": "CommunityList results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of CommunityLists", 
  "type": "object"
}

CommunityMatchCriteria (type)

{
  "additionalProperties": false, 
  "id": "CommunityMatchCriteria", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "criteria": {
      "description": "Match criteria specified as a community list path or a regular expression.", 
      "required": true, 
      "title": "Match criteria based on community list path or a regular expression", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "Tier0RouteMap"
          ], 
          "relationshipType": "ROUTEMAP_COMMUNITY_LIST_RELATIONSHIP", 
          "rightType": [
            "CommunityList"
          ]
        }
      ]
    }, 
    "match_operator": {
      "description": "Match operator for community list entries. Not valid when a regular expression is specified for criteria.", 
      "enum": [
        "MATCH_ANY", 
        "MATCH_ALL", 
        "MATCH_EXACT", 
        "MATCH_COMMUNITY_REGEX", 
        "MATCH_LARGE_COMMUNITY_REGEX"
      ], 
      "required": false, 
      "title": "Match operator for community list entries", 
      "type": "string"
    }
  }, 
  "title": "Match criteria based on a community list", 
  "type": "object"
}

CommunityMatchExpression (type)

{
  "additionalProperties": false, 
  "id": "CommunityMatchExpression", 
  "module_id": "Routing", 
  "properties": {
    "expression": {
      "items": {
        "$ref": "CommunityMatchOperation
      }, 
      "required": true, 
      "title": "Array of community match operations", 
      "type": "array"
    }, 
    "operator": {
      "description": "Operator for evaluating community match expressions. AND logical AND operator", 
      "enum": [
        "AND"
      ], 
      "readonly": true, 
      "title": "Operator", 
      "type": "string"
    }
  }, 
  "title": "Community match expression", 
  "type": "object"
}

CommunityMatchOperation (type)

{
  "additionalProperties": false, 
  "id": "CommunityMatchOperation", 
  "module_id": "Routing", 
  "properties": {
    "community_list_id": {
      "description": "ID of BGP community list. This value is not required when match_operator is MATCH_REGEX otherwise required.", 
      "title": "Community list id", 
      "type": "string"
    }, 
    "match_operator": {
      "default": "MATCH_ANY", 
      "description": "Match operator for communities from provided community list id. MATCH_ANY will match any community MATCH_ALL will match all communities MATCH_EXACT will do exact match on community MATCH_NONE [operator not supported] will not match any community MATCH_REGEX will match normal communities by evaluating regular expression MATCH_LARGE_COMMUNITY_REGEX will match large communities by evaluating regular expression", 
      "enum": [
        "MATCH_ANY", 
        "MATCH_ALL", 
        "MATCH_EXACT", 
        "MATCH_NONE", 
        "MATCH_REGEX", 
        "MATCH_LARGE_COMMUNITY_REGEX"
      ], 
      "title": "Match operator", 
      "type": "string"
    }, 
    "regular_expression": {
      "description": "Regular expression to match BGP communities. If match_operator is MATCH_REGEX then this value must be specified.", 
      "title": "Regular expression", 
      "type": "string"
    }
  }, 
  "title": "Community match operation", 
  "type": "object"
}

ComponentConditionItem (type)

{
  "additionalProperties": false, 
  "description": "This indicate component health condition and the reason why not healthy.", 
  "id": "ComponentConditionItem", 
  "module_id": "PolicyAntreaMonitoring", 
  "properties": {
    "condition_type": {
      "$ref": "ComponentConditionType, 
      "description": "Indicate which component condition it is.", 
      "readonly": true, 
      "title": "Antrea Component condition type"
    }, 
    "last_heartbeat_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Time unit is millisecond.", 
      "title": "Last heartbeat time"
    }, 
    "message": {
      "description": "Additional condition information.", 
      "title": "Antrea Component condition message", 
      "type": "string"
    }, 
    "reason": {
      "description": "Indicate why not healthy.", 
      "title": "Reason of unhealthy status", 
      "type": "string"
    }, 
    "status": {
      "$ref": "ConditionStatus, 
      "description": "Indicate healthy or unhealthy.", 
      "title": "Component condition status"
    }
  }, 
  "title": "Antrea Component condition", 
  "type": "object"
}

ComponentConditionType (type)

{
  "description": "Antrea Component condition names collection.", 
  "enum": [
    "CONTROLLER_HEALTHY", 
    "MP_ADAPTER_HEALTHY", 
    "MP_CONNECTED", 
    "CCP_ADAPTER_HEALTHY", 
    "CCP_SESSION_STATE_UP"
  ], 
  "id": "ComponentConditionType", 
  "module_id": "PolicyAntreaMonitoring", 
  "title": "Antrea Component condition", 
  "type": "string"
}

ComponentMigrationStatus (type)

{
  "additionalProperties": false, 
  "id": "ComponentMigrationStatus", 
  "module_id": "Migration", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the migration of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the migration status", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the migration status", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of migration progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Migration status of component", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentStatus (type)

{
  "description": "Antrea Component status enum. If lose connection, status will be UNKNOWN", 
  "enum": [
    "HEALTHY", 
    "DEGRADED", 
    "FAILED", 
    "UNKNOWN"
  ], 
  "id": "ComponentStatus", 
  "module_id": "PolicyAntreaMonitoring", 
  "title": "Antrea Component status", 
  "type": "string"
}

ComponentTargetVersion (type)

{
  "id": "ComponentTargetVersion", 
  "module_id": "Migration", 
  "properties": {
    "component_type": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "target_version": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentTypeListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ComponentTypeListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type on which the action is performed or on which the results are filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentUpgradeChecksInfo (type)

{
  "additionalProperties": false, 
  "description": "Meta-data of pre/post-upgrade checks for a component", 
  "id": "ComponentUpgradeChecksInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type of the pre/post-upgrade checks", 
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "post_upgrade_checks_info": {
      "items": {
        "$ref": "UpgradeCheckInfo
      }, 
      "required": false, 
      "title": "Collection of post-upgrade checks", 
      "type": "array"
    }, 
    "pre_upgrade_checks_info": {
      "items": {
        "$ref": "UpgradeCheckInfo
      }, 
      "required": false, 
      "title": "Collection of pre-upgrade checks", 
      "type": "array"
    }
  }, 
  "title": "Meta-data of pre/post-upgrade checks for a component", 
  "type": "object"
}

ComponentUpgradeChecksInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComponentUpgradeChecksInfoListResult", 
  "module_id": "Upgrade", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComponentUpgradeChecksInfo
      }, 
      "required": true, 
      "title": "Collection of info of pre/post-upgrade checks for components", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentUpgradeStatus (type)

{
  "additionalProperties": false, 
  "id": "ComponentUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_rollback": {
      "description": "This field indicates whether we can perform upgrade rollback.", 
      "readonly": true, 
      "required": false, 
      "title": "Can perform rollback", 
      "type": "boolean"
    }, 
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComputeClusterIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Idfw configuration for enable/disable idfw on cluster level.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ComputeClusterIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cluster_idfw_enabled": {
      "description": "If set to true, idfw is enabled for this cluster", 
      "readonly": false, 
      "required": true, 
      "title": "Idfw enabled flag", 
      "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"
    }, 
    "is_stale": {
      "description": "If set to true, this cluster has been deleted from NSX.", 
      "readonly": true, 
      "title": "Cluster stale flag", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "member": {
      "$ref": "PolicyResourceReference, 
      "description": "Contains actual policy resource reference object", 
      "required": true, 
      "title": "PolicyResourceReference"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Compute cluster idfw configuration", 
  "type": "object"
}

ComputeClusterIdfwConfigurationListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ComputeClusterIdfwConfigurationListRequestParameters", 
  "module_id": "PolicyFirewallConfiguration", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute cluster idfw configuration request parameters", 
  "type": "object"
}

ComputeClusterIdfwConfigurationListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComputeClusterIdfwConfigurationListResult", 
  "module_id": "PolicyFirewallConfiguration", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeClusterIdfwConfiguration
      }, 
      "required": true, 
      "title": "Compute cluster wise identity firewall configuration list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of compute cluster idfw configuration", 
  "type": "object"
}

ComputeCollection (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ComputeCollection", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "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"
    }, 
    "dpu_config": {
      "$ref": "ClusterDpuConfig, 
      "description": "Specifies property related to cluster homogeneity for SmartNic", 
      "readonly": true, 
      "required": false, 
      "title": "Configuration of homogeneous cluster"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this Compute Collection was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": true, 
      "title": "ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n", 
      "type": "string"
    }, 
    "owner_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the owner of compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "owner_nsx": {
      "description": "Specifies owner nsx of the compute collection. Owner nsx can be SELF, OTHER, MULTIPLE or NONE. SELF applies to when compute collection prepared by that nsx. OTHER applies to when compute collection prepared by other nsx. MULTIPLE applies to when compute collection tried to prepare by multiple nsx at a time. NONE applies to when compute collection is not prepared by any nsx.", 
      "enum": [
        "SELF", 
        "OTHER", 
        "MULTIPLE", 
        "NONE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Specifies owner nsx of the compute collection", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ComputeCollectionAction (type)

{
  "additionalProperties": false, 
  "id": "ComputeCollectionAction", 
  "module_id": "ComputeCollectionDeployment", 
  "properties": {
    "action": {
      "description": "For Compute collection, the supported actions are:  - remove_nsx: removes NSX from the cluster", 
      "enum": [
        "remove_nsx"
      ], 
      "title": "Supported actions on compute-collection", 
      "type": "string"
    }
  }, 
  "title": "Compute collection action parameters", 
  "type": "object"
}

ComputeCollectionListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ComputeCollectionListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cm_local_id": {
      "required": false, 
      "title": "Local Id of the compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "discovered_node_id": {
      "required": false, 
      "title": "Id of the discovered node which belongs to this Compute Collection\n", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Name of the ComputeCollection in source compute manager", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "node_id": {
      "required": false, 
      "title": "Id of the fabric node created from a discovered node belonging to\nthis Compute Collection\n", 
      "type": "string"
    }, 
    "origin_id": {
      "required": false, 
      "title": "Id of the compute manager from where this Compute Collection was discovered", 
      "type": "string"
    }, 
    "origin_type": {
      "required": false, 
      "title": "ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n", 
      "type": "string"
    }, 
    "owner_id": {
      "required": false, 
      "title": "Id of the owner of compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute Collection list parameters", 
  "type": "object"
}

ComputeCollectionListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComputeCollectionListResult", 
  "module_id": "InventoryCmObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeCollection
      }, 
      "required": true, 
      "title": "Compute Collection list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute Collection list result", 
  "type": "object"
}

ComputeCollectionNetworkInterfacesListResult (type)

{
  "description": "List of network interfaces for all discovered nodes in compute collection", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComputeCollectionNetworkInterfacesListResult", 
  "module_id": "InventoryCmObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of discovered node with network interfaces", 
      "items": {
        "$ref": "DiscoveredNodeNetworkInterfaces
      }, 
      "required": true, 
      "title": "Discovered node network interfaces", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ComputeCollection Interfaces List Result", 
  "type": "object"
}

ComputeInstanceErrorMessage (type)

{
  "additionalProperties": false, 
  "description": "Stores an error ID and error message", 
  "id": "ComputeInstanceErrorMessage", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "detailed_message": {
      "description": "Error message string to indicate, if it is NSX or cloud operation generated error.", 
      "readonly": true, 
      "required": true, 
      "title": "Error details", 
      "type": "string"
    }, 
    "error_id": {
      "readonly": true, 
      "required": true, 
      "title": "An error ID contract obtained from PCM", 
      "type": "integer"
    }
  }, 
  "title": "Compute Instance Error Message", 
  "type": "object"
}

ComputeManager (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ComputeManager", 
  "module_id": "InventoryCmObj", 
  "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"
    }, 
    "access_level_for_oidc": {
      "default": "FULL", 
      "description": "Specifies the maximum access level allowed for calls from compute manager to NSX using the OIDC provider.", 
      "enum": [
        "FULL", 
        "LIMITED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Specifies access level to NSX from the compute manager", 
      "type": "string"
    }, 
    "create_service_account": {
      "default": false, 
      "description": "Enable this flag to create service account user on compute manager. This is required by features such as vSphere Lifecycle Manager for authentication with vAPIs from nsx.", 
      "readonly": false, 
      "required": false, 
      "title": "Specifies whether service account is created or not on compute manager", 
      "type": "boolean"
    }, 
    "credential": {
      "$ref": "LoginCredential, 
      "description": "Supported credential types are 'UsernamePasswordLoginCredential', 'SamlTokenLoginCredential', 'SessionLoginCredential'. VerifiableAsymmetricLoginCredential is used for internal purpose only.", 
      "readonly": false, 
      "required": false, 
      "title": "Login credentials for the compute manager"
    }, 
    "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"
    }, 
    "extension_certificate": {
      "$ref": "CertificateData, 
      "description": "Specifies certificate for compute manager extension registered on vCenter.", 
      "readonly": false, 
      "required": false, 
      "title": "Specifies certificate for compute manager extension"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "multi_nsx": {
      "default": false, 
      "description": "Enable this flag to manage same compute manager by multiple nsx.", 
      "readonly": false, 
      "required": false, 
      "title": "Specifies whether multi nsx feature is enabled for compute manager", 
      "type": "boolean"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of compute manager", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": false, 
      "required": true, 
      "title": "Compute manager type like vCenter", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "reverse_proxy_https_port": {
      "default": 443, 
      "description": "Specifies https port of the reverse proxy to connect to compute manager. For e.g. In case of VC, this port can be retrieved from this config file /etc/vmware-rhttpproxy/config.xml.", 
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": false, 
      "required": false, 
      "title": "Proxy https port of compute manager", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": true, 
      "title": "IP address or hostname of compute manager", 
      "type": "string"
    }, 
    "set_as_oidc_provider": {
      "default": false, 
      "description": "If the compute manager is VC and need to set set as OIDC provider for NSX then this flag should be set as true. This is specific to wcp feature, should be enabled when this feature is being used.", 
      "readonly": false, 
      "required": false, 
      "title": "Specifies whether compute manager has been set as OIDC provider", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ComputeManagerListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ComputeManagerListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": false, 
      "required": false, 
      "title": "Compute manager type like vCenter", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": false, 
      "title": "IP address or hostname of compute manager", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute manager list parameters", 
  "type": "object"
}

ComputeManagerListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComputeManagerListResult", 
  "module_id": "InventoryCmObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeManager
      }, 
      "required": true, 
      "title": "List of compute managers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of compute managers", 
  "type": "object"
}

ComputeManagerStatus (type)

{
  "additionalProperties": false, 
  "id": "ComputeManagerStatus", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "connection_errors": {
      "help_detail": "Errors will be cleared after successful connection", 
      "items": {
        "$ref": "ErrorInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Errors when connecting with compute manager", 
      "type": "array"
    }, 
    "connection_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "CONNECTING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of connection with the compute manager", 
      "type": "string"
    }, 
    "connection_status_details": {
      "help_detail": "Details, if any, about the current status of the connection with the compute manager", 
      "readonly": true, 
      "required": false, 
      "title": "Details about connection status", 
      "type": "string"
    }, 
    "last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp of the last successful update of Inventory, in epoch milliseconds."
    }, 
    "oidc_end_point_id": {
      "description": "If Compute manager is trusted as authorization server, then this Id will be Id of corresponding oidc end point.", 
      "readonly": true, 
      "required": false, 
      "title": "Specifies Id of corresponding OidcEndPoint", 
      "type": "string"
    }, 
    "registration_errors": {
      "help_detail": "Errors will be cleared after successful registration", 
      "items": {
        "$ref": "ErrorInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Errors when registering with compute manager", 
      "type": "array"
    }, 
    "registration_status": {
      "enum": [
        "REGISTERED", 
        "UNREGISTERED", 
        "REGISTERING", 
        "REGISTERED_WITH_ERRORS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Registration status of compute manager", 
      "type": "string"
    }, 
    "version": {
      "readonly": true, 
      "required": false, 
      "title": "Version of the compute manager", 
      "type": "string"
    }
  }, 
  "title": "Runtime status information of the compute manager", 
  "type": "object"
}

ComputeManagerTopology (type)

{
  "id": "ComputeManagerTopology", 
  "module_id": "NvdsUpgradeReadinessCheck", 
  "properties": {
    "compute_manager_id": {
      "required": true, 
      "title": "Identifier of vcenter where VDS will be created", 
      "type": "string"
    }, 
    "dvswitch": {
      "items": {
        "$ref": "VdsTopology
      }, 
      "required": true, 
      "title": "Datacenter, VDS mapping", 
      "type": "array"
    }
  }, 
  "title": "Details where NVDS will be migrated to", 
  "type": "object"
}

Condition (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level condition. Evaluation of the condition expression will be case insensitive.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "Condition", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "Condition"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "exclude": {
      "$ref": "ExcludedMembersList, 
      "description": "List of members to be excluded from the condition. This field is applicable only for condition representing the list of malicious IPs. Only IPAddressExpression and PathExpression are supported. The PathExpression should have paths of Groups that of the group_type IPAddress. Multiple PathExpressions are not supported here.", 
      "required": false, 
      "title": "Members to be excluded from the condition"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key": {
      "enum": [
        "Tag", 
        "Name", 
        "OSName", 
        "ComputerName", 
        "NodeType", 
        "GroupType", 
        "ALL", 
        "IPAddress", 
        "PodCidr"
      ], 
      "required": true, 
      "title": "Key", 
      "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"
    }, 
    "member_type": {
      "description": "For global groups (groups created from Global Manager), the supported Member Types are - VirtualMachine, Segment, SegmentPort, Group, DVPG and DVPort. For local groups (groups created on the local policy manager), the supported member types are IPSet, VirtualMachine, LogicalPort, LogicalSwitch, Segment, SegmentPort, Pod, Service, Namespace, TransportNode, Group, DVPG, DVPort, KubernetesCluster, KubernetesNamespace, AntreaEgress, AntreaIPPool, KubernetesIngress, KubernetesGateway, KubernetesService and KubernetesNode.", 
      "enum": [
        "IPSet", 
        "VirtualMachine", 
        "LogicalPort", 
        "LogicalSwitch", 
        "Segment", 
        "SegmentPort", 
        "Pod", 
        "Service", 
        "Namespace", 
        "TransportNode", 
        "Group", 
        "DVPG", 
        "DVPort", 
        "IPAddress", 
        "KubernetesCluster", 
        "KubernetesNamespace", 
        "AntreaEgress", 
        "AntreaIPPool", 
        "KubernetesIngress", 
        "KubernetesGateway", 
        "KubernetesService", 
        "KubernetesNode"
      ], 
      "required": true, 
      "title": "Group member type", 
      "type": "string"
    }, 
    "operator": {
      "description": "Operator is made non-mandatory to support Segment and SegmentPort tag based expression. To evaluate expression for other types, operator value should be provided.", 
      "enum": [
        "EQUALS", 
        "CONTAINS", 
        "STARTSWITH", 
        "ENDSWITH", 
        "NOTEQUALS", 
        "NOTIN", 
        "MATCHES", 
        "IN"
      ], 
      "required": false, 
      "title": "operator", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "scope_operator": {
      "description": "Default operator when not specified explicitly would be considered as EQUALS. If value for Condition is empty, then condition will not be evaluated. For example, Condition with key as Tag and value as \"|tag\" would be evaluated for tag value not for empty scope value.", 
      "enum": [
        "EQUALS", 
        "NOTEQUALS"
      ], 
      "required": false, 
      "title": "operator", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "value": {
      "minLength": 1, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "Represents the leaf level condition", 
  "type": "object"
}

ConditionStatus (type)

{
  "description": "Antrea Component condition status shared by all component condition.", 
  "enum": [
    "HEALTHY", 
    "UNHEALTHY"
  ], 
  "id": "ConditionStatus", 
  "module_id": "PolicyAntreaMonitoring", 
  "title": "Antrea Component condition status", 
  "type": "string"
}

ConditionalForwarderZone (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ForwarderZone
  }, 
  "id": "ConditionalForwarderZone", 
  "module_id": "DnsForwarder", 
  "properties": {
    "domain_names": {
      "description": "A forwarder domain name should be a valid FQDN. If reverse lookup is needed for this zone, reverse lookup domain name like X.in-addr.arpa can be defined. Here the X represents a subnet.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 100, 
      "minItems": 1, 
      "required": true, 
      "title": "Domain names of a forwarder zone", 
      "type": "array"
    }, 
    "source_ip": {
      "$ref": "IPv4Address, 
      "description": "The source ip used by the fowarder of the zone. If no source ip specified, the ip address of listener of the DNS forwarder will be used.", 
      "required": false, 
      "title": "Source ip of the forwarder"
    }, 
    "upstream_servers": {
      "description": "Ip address of the upstream DNS servers the DNS forwarder accesses.", 
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "Ips of upsteam DNS servers", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ConditionalValueConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level expression to restrict the target attribute value based on the set of existing values. Generally, used in combination with RelatedAttributeConditionalExpression to constraint the values related to another attribute on the same resource. This object is always used in conjunction with some exression. Example - {   \"condition\" : {       \"operator\":\"INCLUDES\",       \"rhs_value\": [\"/infra/domains/mgw/groups/VCENTER\", \"/infra/domains/mgw/groups/SRM\", \"/infra/domains/mgw/groups/NSX\"],       \"value_constraint\": {           \"resource_type\": \"ValueConstraintExpression\",           \"operator\":\"EXCLUDES\",           \"values\":[\"/infra/domains/mgw/groups/VCENTER\", \"/infra/domains/mgw/groups/SRM\", \"/infra/domains/mgw/groups/NSX\"]   } }", 
  "id": "ConditionalValueConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "operator": {
      "description": "INCLUDES_ANY operator supported only for StringArrayConstraintValue", 
      "enum": [
        "INCLUDES", 
        "INCLUDES_ANY", 
        "EXCLUDES", 
        "EQUALS"
      ], 
      "required": true, 
      "title": "Set operation to constraint values.", 
      "type": "string"
    }, 
    "rhs_value": {
      "description": "List of values.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Array of values to perform operation.", 
      "type": "array"
    }, 
    "rhs_value_with_type": {
      "$ref": "ConstraintValue, 
      "description": "List of values.", 
      "required": false, 
      "title": "Array of values to perform operation."
    }, 
    "value_constraint": {
      "$ref": "ValueConstraintExpression, 
      "description": "Values to apply the conditional constraint on target.", 
      "required": true, 
      "title": "Value Constraint"
    }
  }, 
  "title": "Represents the leaf level conditional value constraint.", 
  "type": "object"
}

ConfigState (type)

{
  "additionalProperties": false, 
  "description": "Configuration State.", 
  "enum": [
    "SUCCESS", 
    "IN_PROGRESS", 
    "ERROR", 
    "UNKNOWN", 
    "UNINITIALIZED"
  ], 
  "id": "ConfigState", 
  "module_id": "PolicyRealizedState", 
  "title": "Config State", 
  "type": "string"
}

ConfigType (type)

{
  "enum": [
    "nsxa-state", 
    "nsxa-edge-cluster", 
    "nsxa-lrouter", 
    "nsxa-service-router", 
    "nestdb", 
    "edge-agent", 
    "dataplane", 
    "nsd", 
    "manager", 
    "controller", 
    "core"
  ], 
  "id": "ConfigType", 
  "title": "Config Type", 
  "type": "string"
}

ConfigurationState (type)

{
  "id": "ConfigurationState", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ConfigurationStateElement (type)

{
  "id": "ConfigurationStateElement", 
  "module_id": "Common", 
  "properties": {
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "in_sync", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_FAILED", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_FAILED", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "EDGE_CONFIG_ERROR", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_NETWORK_EDIT_PENDING", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "NOT_AVAILABLE", 
        "REGISTRATION_TIMEDOUT", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "pending", 
        "orphaned", 
        "unknown", 
        "error"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "State of configuration on this sub system", 
      "type": "string"
    }, 
    "sub_system_address": {
      "readonly": true, 
      "required": false, 
      "title": "URI of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_id": {
      "readonly": true, 
      "required": false, 
      "title": "Identifier of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_type": {
      "readonly": true, 
      "required": false, 
      "title": "Type of backing resource on sub system", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ConjunctionOperator (type)

{
  "additionalProperties": false, 
  "description": "Represents the operators AND or OR.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "ConjunctionOperator", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConjunctionOperator"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "conjunction_operator": {
      "enum": [
        "OR", 
        "AND"
      ], 
      "required": true, 
      "title": "Conjunction Operator Node", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Represents the operators AND or OR", 
  "type": "object"
}

ConnectivityAdvancedConfig (type)

{
  "additionalProperties": false, 
  "id": "ConnectivityAdvancedConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "connectivity": {
      "default": "ON", 
      "description": "Connectivity configuration to manually connect (ON) or disconnect (OFF) Tier-0/Tier1 segment from corresponding gateway. This property does not apply to VLAN backed segments. VLAN backed segments with connectivity OFF does not affect its layer-2 connectivity.", 
      "enum": [
        "ON", 
        "OFF"
      ], 
      "required": false, 
      "title": "Connectivity configuration", 
      "type": "string"
    }
  }, 
  "title": "Advanced configuration for Policy connectivity", 
  "type": "object"
}

ConsolidatedAPIListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ConsolidatedAPIListRequestParameters", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_filter": {
      "$ref": "IPElement, 
      "description": "This filter can be used to verify an ip membership in the effective results", 
      "required": false, 
      "title": "An IPAddress or subnet for filtering the results."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "site_id": {
      "required": false, 
      "title": "UUID of the site from which the effective IP addresses are to be fetched\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Consolidated effective IP addresses API list request parameters", 
  "type": "object"
}

ConsolidatedEffectiveIPAddressMemberListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ConsolidatedEffectiveIPAddressMemberListResult", 
  "module_id": "GroupingObjectsProviders", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EffectiveIPInfo
      }, 
      "required": true, 
      "title": "Paged Collection of site wise consolidated effective ip addresses for the given NSGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ConsolidatedEffectiveIPListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "List request params for the pass through type api that get data from the Enforcement point. Enforcement point is mandatory for this request.", 
  "extends": {
    "$ref": "ConsolidatedAPIListRequestParameters
  }, 
  "id": "ConsolidatedEffectiveIPListRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point on which the API needs to be executed. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_filter": {
      "$ref": "IPElement, 
      "description": "This filter can be used to verify an ip membership in the effective results", 
      "required": false, 
      "title": "An IPAddress or subnet for filtering the results."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "site_id": {
      "required": false, 
      "title": "UUID of the site from which the effective IP addresses are to be fetched\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Consolidated API Realization list request params", 
  "type": "object"
}

ConsolidatedRealizedStatus (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Realized Status of an intent object across enforcement points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "ConsolidatedRealizedStatus", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status across enforcement points.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "consolidated_status_per_enforcement_point": {
      "description": "List of Consolidated Realized Status per enforcement point.", 
      "items": {
        "$ref": "ConsolidatedStatusPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of Consolidated Realized Status per Enforcement Point", 
      "type": "array"
    }, 
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "intent_version": {
      "description": "Represent highest intent version across all realized objects", 
      "readonly": true, 
      "title": "Intent version for the status", 
      "type": "string"
    }, 
    "publish_status": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Aggregated Realization state of this object", 
      "type": "string"
    }
  }, 
  "title": "Consolidated Realized Status for an Intent Object", 
  "type": "object"
}

ConsolidatedStatus (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Status of an intent object. Status Consolidation of an intent happens at multiple levels: - Per Enforcement Point: calculation of the consolidated status is performed using all realized entities that the intent objet maps to on a specific enforcement point. - Across Enforcement Points: calculation of the consolidated status is performend aggregating the consolidated status from each enforcement point.", 
  "id": "ConsolidatedStatus", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "consolidated_status": {
      "$ref": "ConfigState, 
      "description": "Consolidated Realized Status of an intent object.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }
  }, 
  "title": "Consolidated Status", 
  "type": "object"
}

ConsolidatedStatusNsxT (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status of an intent object on an NSX-T type of enforcement point.", 
  "extends": {
    "$ref": "ConsolidatedStatusPerEnforcementPoint
  }, 
  "id": "ConsolidatedStatusNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConsolidatedStatusNsxT"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforced_status": {
      "$ref": "EnforcedStatusDetailsNsxT, 
      "description": "Detailed Realized Status inherent to an NSX-T Enforcement Point.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Consolidated Status", 
  "type": "object"
}

ConsolidatedStatusPerEnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Realized Status Per Enforcement Point.", 
  "extends": {
    "$ref": "BaseConsolidatedStatusPerEnforcementPoint
  }, 
  "id": "ConsolidatedStatusPerEnforcementPoint", 
  "module_id": "PolicyRealizedState", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConsolidatedStatusPerEnforcementPoint"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "Consolidated Realized Status Per Enforcement Point", 
  "type": "object"
}

ConstantFieldValue (type)

{
  "additionalProperties": false, 
  "description": "Constant Field Value.", 
  "extends": {
    "$ref": "FieldSettingValue
  }, 
  "id": "ConstantFieldValue", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConstantFieldValue"
  }, 
  "properties": {
    "constant": {
      "description": "Constant Value that the field must be set to.", 
      "title": "Constant Value", 
      "type": "object"
    }, 
    "resource_type": {
      "description": "Field Setting Value resource type.", 
      "enum": [
        "ConstantFieldValue"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Constant Field Value", 
  "type": "object"
}

Constraint (type)

{
  "additionalProperties": false, 
  "description": "Constraint object to constraint any attribute on a resource based on specified expression. Example- Restrict the allowed services in Edge Communication Entry to list of  services, if the destinationGroups contain vCenter. {   \"target\":{      \"target_resource_type\":\"CommunicationEntry\",      \"attribute\":\"services\",      \"path_prefix\":\"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries\"   }   \"constraint_expression\":{     \"related_attribute\":{       \"attribute\":\"destinationGroups\"     }     \"condition\":{       \"operator\":\"INCLUDES\",       \"rhs_value\":{\"vCenter\"}       \"value_constraint\":{           \"operator\":\"ALLOW\",           \"values\":{\"/ref/services/HTTPS\", \"/ref/services/HTTOP\", ...}      }     }   } }", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Constraint", 
  "module_id": "PolicyConstraints", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "constraint_expression": {
      "$ref": "ConstraintExpression, 
      "deprecated": true, 
      "description": "This property is deprecated. Please use the \"constraint_expressions\" property instead to specify one or more constraint expressions. If this property is populated, then the \"constraint_expressions\" value is ignored.", 
      "required": false, 
      "title": "Expression to constrain the target attribute value."
    }, 
    "constraint_expressions": {
      "descripiton": "An array of expressions. Note that if the deprecated property\n\"constraint_expression\" has a value then this property is\nignored. Please empty out the value of \"constraint_expression\"\nbefore using this property.\n", 
      "items": {
        "$ref": "ConstraintExpression
      }, 
      "required": false, 
      "title": "Expressions to constrain the target attribute value.", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "message": {
      "required": false, 
      "title": "User friendly message to be shown to users upon violation.", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target": {
      "$ref": "ConstraintTarget, 
      "deprecated": true, 
      "description": "This property is deprecated. Please use the \"targets\" property instead to specify one or more targets. If this property is populated, then the \"targets\" value is ignored.", 
      "required": false, 
      "title": "Target resource attribute details."
    }, 
    "target_owner_type": {
      "default": "ALL", 
      "descripiton": "Every target resource in the policy tree is owned by either local LM or remote GM/LM.\nThis target_owner_type property helps to apply constraints exclusively to only targets which are managed\nby Gloal policy manager Or local policy manager.\nGM: Target's owner type GM indicates that apply constraints to targets that are owned by GM\nLM: Target's owner type LM indicates that apply constraints to targets that are owned by\n    local policy manager. With owner_type as LM, Constraint will not be applied to targets owned by\n    GM. This owner_type is not allowed on GM/PMaaS.  User can configure this type only on local SDDC/LM.\nALL:  Default type. This indicates that constraints will be applied to all\n      targets either local or remote.\nDefault is ALL\n", 
      "enum": [
        "GM", 
        "LM", 
        "ALL"
      ], 
      "required": false, 
      "title": "Constraint target's owner type", 
      "type": "string"
    }, 
    "targets": {
      "descripiton": "An array of targets to apply constraints. Note that if the\ndeprecated property \"target\" has a value then this property\nis ignored. Please empty out the value of \"target\" before using\nthis property.\n", 
      "items": {
        "$ref": "ConstraintTarget
      }, 
      "required": false, 
      "title": "Collection of target resources attribute details.", 
      "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": "Constraint definition.", 
  "type": "object"
}

ConstraintExpression (type)

{
  "abstract": true, 
  "description": "All the types of the expression extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for constraint expression", 
  "type": "object"
}

ConstraintListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ConstraintListResult", 
  "module_id": "PolicyConstraints", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Constraint
      }, 
      "required": true, 
      "title": "Constraint list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Constraints", 
  "type": "object"
}

ConstraintTarget (type)

{
  "additionalProperties": false, 
  "description": "Resource attribute on which constraint should be applied. Example - sourceGroups attribute of Edge CommunicationEntry to be   restricted, is given as:   {      \"target_resource_type\":\"CommunicationEntry\",      \"attribute\":\"sourceGroups\",      \"path_prefix\":\"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries\"   }", 
  "id": "ConstraintTarget", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "attribute": {
      "required": false, 
      "title": "Attribute name of the target entity.", 
      "type": "string"
    }, 
    "path_prefix": {
      "required": false, 
      "title": "Path prefix of the entity to apply constraint.\nThis is required to further disambiguiate if multiple policy entities\nshare the same resource type.\nExample - Edge FW and DFW use the same resource type CommunicationMap,\nCommunicationEntry, Group, etc.\n", 
      "type": "string"
    }, 
    "target_resource_type": {
      "required": false, 
      "title": "Resource type of the target entity. This is required in case the\nconstraint expressions do not specify target resource type.\n", 
      "type": "string"
    }
  }, 
  "title": "Resource attribute on which constraint should be applied.", 
  "type": "object"
}

ConstraintValue (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the types of value extend from this abstract class. This is present for extensibility.", 
  "id": "ConstraintValue", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StringArrayConstraintValue", 
        "CidrArrayConstraintValue", 
        "IntegerArrayConstraintValue"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Base class for each value configuration", 
  "type": "object"
}

ContainerApplication (type)

{
  "description": "Container application within a project.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerApplication", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cluster_ips": {
      "description": "The IPv4 and IPv6 clusterIPs of the container application.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of cluster IPs", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this container application belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this container application belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Identifier of the container application on container cluster e.g. PCF app id, k8s service id.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container application", 
      "type": "string"
    }, 
    "load_balancer_ingress": {
      "description": "Specifies list of load-balancer ingress points", 
      "items": {
        "$ref": "ContainerLoadBalancerIngress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of load-balancer ingress points", 
      "type": "array"
    }, 
    "network_errors": {
      "description": "List of network errors related to container application.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container application.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container application", 
      "type": "string"
    }, 
    "node_port_local_endpoints": {
      "description": "Specifies list of local endpoint, when service is NodePortLocal.", 
      "items": {
        "$ref": "NodePortLocalEndpoint
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of NodePortLocalEndpoint", 
      "type": "array"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container application in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_ports": {
      "description": "Specifies list of service port.", 
      "items": {
        "$ref": "ContainerServicePort
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of service port", 
      "type": "array"
    }, 
    "status": {
      "description": "Status of the container application.", 
      "enum": [
        "UNKNOWN", 
        "HEALTHY", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the container application", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "descrption": "Specifies the type of container application. e.g. In case of Kubernetes\ncontainer cluster, it specifies type of service like ClusterIP, NodePort,\nLoadBalancer or ExternalName.\n", 
      "enum": [
        "CLUSTER_IP", 
        "NODE_PORT", 
        "LOAD_BALANCER", 
        "EXTERNAL_NAME"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of container application", 
      "type": "string"
    }
  }, 
  "title": "Container application within a project", 
  "type": "object"
}

ContainerApplicationInstance (type)

{
  "description": "Container application instance within a project.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerApplicationInstance", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cluster_node_id": {
      "description": "Cluster node id where application instance is running.", 
      "readonly": false, 
      "required": false, 
      "title": "Cluster node id", 
      "type": "string"
    }, 
    "container_application_ids": {
      "description": "List of identifiers of the container application.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Identifiers of the container application", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this application instance belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the container project which this container application instance belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Identifier of the container application instance on container cluster.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container application instance", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container application instance.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container application instance.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container application instance", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container application instance in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "status": {
      "description": "Status of the container application instance.", 
      "enum": [
        "UNKNOWN", 
        "HEALTHY", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the container application instance", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Application Instance", 
  "type": "object"
}

ContainerApplicationInstanceGroupAssociationRequestParams (type)

{
  "description": "List request parameters containing ContainerApplicationInstance(pod) id and enforcement point path", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ContainerApplicationInstanceGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "pod_id": {
      "required": true, 
      "title": "ContainerApplicationInstance", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing ContainerApplicationInstance(pod) id and enforcement point path", 
  "type": "object"
}

ContainerApplicationInstanceListRequestParameters (type)

{
  "description": "Request object, containing multiple properties, based on which the result will be filtered. None or multiple properties can be passed as filter criteria. If multiple properties are passed then result will be the intersection of the resultsets by applying each filter individually.", 
  "extends": {
    "$ref": "ContainerObjectsListRequestParameters
  }, 
  "id": "ContainerApplicationInstanceListRequestParameters", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "container_application_id": {
      "description": "Identifier of the container application.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container application", 
      "type": "string"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the container project.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container project", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "scope_id": {
      "description": "Specifies scope id for container cluster. Default value is same as identifier of the cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Scope id for container cluster", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Container application instance list parameters", 
  "type": "object"
}

ContainerApplicationInstanceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerApplicationInstanceListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerApplicationInstance
      }, 
      "required": true, 
      "title": "List of Container Applications", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerApplicationListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerApplicationListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerApplication
      }, 
      "required": true, 
      "title": "List of Container Applications", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerCluster (type)

{
  "description": "Details of container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerCluster", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cluster_ip_ranges": {
      "description": "In case of Kubernetes container cluster, it specifies CIDRs that will be assigned to services created on Kubernetes.", 
      "items": {
        "$ref": "IPCIDRBlock
      }, 
      "maxItems": 2, 
      "readonly": false, 
      "required": false, 
      "title": "List of cluster IP range", 
      "type": "array"
    }, 
    "cluster_type": {
      "description": "Type of the container cluster. In case of creating container cluster first time, it is expected to pass the valid cluster-type. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.", 
      "enum": [
        "PAS", 
        "PKS", 
        "Kubernetes", 
        "Openshift", 
        "WCP", 
        "WCP_Guest", 
        "AKS", 
        "EKS", 
        "TKGm", 
        "TKGi", 
        "GKE", 
        "Gardener", 
        "Rancher", 
        "TAS", 
        "Other"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of the container cluster", 
      "type": "string"
    }, 
    "cni_type": {
      "default": "Other", 
      "description": "Specifies Container Network Interface type for container cluster.", 
      "enum": [
        "NCP", 
        "Antrea", 
        "Other"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "CNI type for container cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "External identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "External identifier of the container cluster", 
      "type": "string"
    }, 
    "infrastructure": {
      "$ref": "ContainerInfrastructureInfo, 
      "description": "Details of underlying infrastructure that hosts the container cluster. In case of creating container cluster first time, it is expected to pass the valid infrastructure. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.", 
      "readonly": false, 
      "required": false, 
      "title": "Details of infrastructure for the container cluster"
    }, 
    "network_errors": {
      "description": "List of network errors related to container cluster.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container cluster.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container cluster", 
      "type": "string"
    }, 
    "node_port_local_range": {
      "description": "Specifies the port range to be used for NodePortLocal services.", 
      "format": "port-or-range", 
      "readonly": false, 
      "required": false, 
      "title": "Node port local range", 
      "type": "string"
    }, 
    "node_port_range": {
      "description": "In case of Kubernetes container cluster, it specifies port range to be used for Kubernetes services created with the type NodePort.", 
      "format": "port-or-range", 
      "readonly": false, 
      "required": false, 
      "title": "Node port range", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container cluster in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "supervisor_project_id": {
      "description": "Specifies supervisor container project identifier for cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Supervisor ContainerProject identifier for cluster", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container cluster", 
  "type": "object"
}

ContainerClusterFilterParameters (type)

{
  "description": "Request object, containing multiple properties, based on which the result will be filtered. None or multiple properties can be passed as filter criteria. If multiple properties are passed then result will be the intersection of the resultsets by applying each filter individually.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ContainerClusterFilterParameters", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "container_cluster_id": {
      "description": "Identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "scope_id": {
      "description": "Specifies scope id for container cluster. Default value is same as identifier of the cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Scope id for container cluster", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Container cluster filter parameter", 
  "type": "object"
}

ContainerClusterListRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ContainerClusterListRequestParameters", 
  "module_id": "TnContainerStatus", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status": {
      "$ref": "TnContainerStatusType, 
      "title": "Container cluster status"
    }
  }, 
  "type": "object"
}

ContainerClusterListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerClusterListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerCluster
      }, 
      "required": true, 
      "title": "List of Container Clusters", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerClusterNode (type)

{
  "description": "Details of container cluster node i.e. container host.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerClusterNode", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "cni_agent_status": {
      "description": "Specifies Container Network Interface agent status of container cluster node.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "CNI agent status of container cluster node", 
      "type": "string"
    }, 
    "container_cluster_id": {
      "description": "External identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "External identifier of the container cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "External identifier of the container cluster node in K8S/PAS.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container cluster node", 
      "type": "string"
    }, 
    "external_ip_addresses": {
      "description": "Specifies list of external ip address of Node.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of external ip address of Node", 
      "type": "array"
    }, 
    "ip_addresses": {
      "description": "List of IP addresses of container cluster node.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "IP Addresses of Node", 
      "type": "array"
    }, 
    "network_errors": {
      "description": "List of network errors related to container cluster node.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container cluster node.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container cluster node", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container cluster node in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "pod_cidrs": {
      "description": "In case of Kubernetes container cluster, it represents the IP ranges assigned to the node for usage by Pod on that node.", 
      "items": {
        "$ref": "IPCIDRBlock
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of CIDR of container application instance", 
      "type": "array"
    }, 
    "provider_id": {
      "description": "Specifies identifier of container cluster node given by infrastructure provider of container cluster. e.g. in case of vSpehere, it will be instance uuid of worker node virtual machine.", 
      "readonly": false, 
      "required": false, 
      "title": "Provider id of container node", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container cluster node", 
  "type": "object"
}

ContainerClusterNodeListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerClusterNodeListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerClusterNode
      }, 
      "required": true, 
      "title": "List of container cluster nodes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerClusterPropertiesFilterParameters (type)

{
  "description": "Request object, containing multiple cluster properties, based on which the result will be filtered. None or multiple properties can be passed as filter criteria. If multiple properties are passed then result will be the intersection of the resultsets by applying each filter individually.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ContainerClusterPropertiesFilterParameters", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "cluster_type": {
      "description": "This is the type of container cluster.", 
      "enum": [
        "PAS", 
        "PKS", 
        "Kubernetes", 
        "Openshift", 
        "WCP", 
        "WCP_Guest", 
        "AKS", 
        "EKS", 
        "TKGm", 
        "TKGi", 
        "GKE", 
        "Gardener", 
        "Rancher", 
        "TAS", 
        "Other"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of container cluster", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "infra_type": {
      "description": "This is the type of container's infrastructure.", 
      "enum": [
        "vSphere", 
        "AWS", 
        "Azure", 
        "Google", 
        "VMC", 
        "KVM", 
        "Baremetal"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of infrastructure", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "scope_id": {
      "description": "Specifies scope id for container cluster. Default value is same as identifier of the cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Scope id for container cluster", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Container cluster filter parameter by cluster properties", 
  "type": "object"
}

ContainerClusterStatus (type)

{
  "id": "ContainerClusterStatus", 
  "module_id": "TnContainerStatus", 
  "properties": {
    "cluster_id": {
      "description": "Identifier of the container cluster.", 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "detail": {
      "description": "Detail information on status.", 
      "title": "Detail information on status", 
      "type": "string"
    }, 
    "interval": {
      "description": "Display the cluster check interval in seconds.", 
      "maximum": 600, 
      "minimum": 60, 
      "readonly": true, 
      "title": "Container cluster status check interval", 
      "type": "int"
    }, 
    "status": {
      "$ref": "TnContainerStatusType, 
      "description": "Display the container cluster status.", 
      "title": "Container cluster status"
    }
  }, 
  "type": "object"
}

ContainerClusterStatusList (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerClusterStatusList", 
  "module_id": "TnContainerStatus", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Container cluster list.", 
      "items": {
        "$ref": "ContainerClusterSummary
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Container cluster list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of the Container cluster", 
  "type": "object"
}

ContainerClusterSummary (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ContainerClusterSummary", 
  "module_id": "TnContainerStatus", 
  "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"
    }, 
    "cluster_id": {
      "description": "Identifier of the container cluster.", 
      "readonly": true, 
      "required": true, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "cluster_name": {
      "description": "Display the container cluster name", 
      "required": true, 
      "title": "Container cluster name", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "detail": {
      "description": "Detail information on status.", 
      "readonly": true, 
      "required": false, 
      "title": "Detail information on status", 
      "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "TnContainerStatusType, 
      "description": "Display the container cluster status.", 
      "required": true, 
      "title": "Container cluster status"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "$ref": "ContainerClusterType, 
      "description": "Container cluster type.", 
      "title": "Container cluster type"
    }
  }, 
  "type": "object"
}

ContainerClusterType (type)

{
  "additionalProperties": false, 
  "enum": [
    "PAS", 
    "PKS", 
    "Kubernetes", 
    "Openshift", 
    "WCP", 
    "Other"
  ], 
  "id": "ContainerClusterType", 
  "module_id": "TnContainerStatus", 
  "title": "Container cluster type", 
  "type": "string"
}

ContainerConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents a container to group widgets that belong to a common category or have a common purpose.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "ContainerConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ContainerConfiguration"
  }, 
  "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"
    }, 
    "condition": {
      "description": "If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "deprecated": true, 
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "filters": {
      "description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "A List of filter ids applied to this widget configuration", 
      "type": "array"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "header": {
      "$ref": "Header
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "labels": {
      "description": "Labels for the container.", 
      "items": {
        "$ref": "Label
      }, 
      "minItems": 0, 
      "title": "Labels", 
      "type": "array"
    }, 
    "layout": {
      "$ref": "Layout, 
      "deprecated": true, 
      "description": "Layout of widgets can be either vertical or horizontal. If layout is not specified a default horizontal layout is applied. This property is deprecated. Now the layout inside the container can be taken care with the help of 'rowspan' and 'colspan' property.", 
      "title": "Layout of widgets inside container"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "plot_configs": {
      "description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.", 
      "items": {
        "$ref": "WidgetPlotConfiguration
      }, 
      "required": false, 
      "title": "List of plotting configuration for a given widget.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "CustomFilterWidgetConfiguration", 
        "TimeRangeDropdownFilterWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration", 
        "SpacerWidgetConfiguration", 
        "LegendWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "rowspan": {
      "description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.", 
      "minimum": 1, 
      "title": "Vertical span", 
      "type": "int"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "show_header": {
      "description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.", 
      "title": "This decides to show the container header or not.", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widgets": {
      "description": "If not specified, creates an empty container.", 
      "items": {
        "$ref": "WidgetItem
      }, 
      "minItems": 0, 
      "title": "Widgets held by the container", 
      "type": "array"
    }
  }, 
  "title": "Container that holds widgets", 
  "type": "object"
}

ContainerEgress (type)

{
  "description": "Details of Container Egress.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerEgress", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this egress belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "egress_ip": {
      "description": "Container egress IP.", 
      "format": "ip", 
      "readonly": false, 
      "required": false, 
      "title": "Container egress IP", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container egress.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container egress", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container egress in key-value format. e.g. key can be externalIPPool, value is a string", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "This specifies yaml definition of ContainerEgress resource. e.g. yaml definition of kubernetes egress resource.", 
      "readonly": false, 
      "required": false, 
      "title": "Container egress specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Egress", 
  "type": "object"
}

ContainerEgressListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerEgressListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Specifies list of container egress.", 
      "items": {
        "$ref": "ContainerEgress
      }, 
      "required": true, 
      "title": "List of ContainerEgress", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerGateway (type)

{
  "description": "A Gateway describes how traffic can be translated to Services within the container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerGateway", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "addresses": {
      "description": "Specifies addresses which lists the IP addresses that have actually been bound to the gateway.", 
      "items": {
        "$ref": "ContainerGatewayAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of addresses bound to gateway", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Specifies identifier of the container cluster of this container gateway.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Specifies identifier of the container project of this container gateway.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container project", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Specifies identifier of the container gateway.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container gateway", 
      "type": "string"
    }, 
    "listeners": {
      "description": "Specifies list of listeners which defines logical endpoints that are bound on this Gateway's addresses.", 
      "items": {
        "$ref": "ContainerGatewayListener
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of listener", 
      "type": "array"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ip pool in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "This specifies yaml definition of ContainerGateway resource.", 
      "readonly": false, 
      "required": false, 
      "title": "Container gateway specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container gateway", 
  "type": "object"
}

ContainerGatewayAddress (type)

{
  "description": "Specifies an address that can be bound to a container gateway.", 
  "id": "ContainerGatewayAddress", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "address": {
      "description": "Specifies address of container gateway.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Address of container gateway", 
      "type": "string"
    }, 
    "type": {
      "description": "Specifies type of gateway address. e.g. Hostname, IPAddress, NamedAddress.", 
      "enum": [
        "HOST_NAME", 
        "IP_ADDRESS", 
        "NAMED_ADDRESS"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of gateway address", 
      "type": "string"
    }
  }, 
  "title": "Container gateway address", 
  "type": "object"
}

ContainerGatewayListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerGatewayListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerGateway
      }, 
      "required": true, 
      "title": "List of Container Gateway", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerGatewayListener (type)

{
  "description": "Listener embodies the concept of a logical endpoint where a Gateway accepts network connections.", 
  "id": "ContainerGatewayListener", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "hostname": {
      "description": "Specifies the virtual hostname to match for protocol type.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Hostname of gateway listener", 
      "type": "string"
    }, 
    "name": {
      "description": "Specifies name of gateway listener", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Name of gateway listener", 
      "type": "string"
    }, 
    "port": {
      "description": "Specifies network port of gateway.", 
      "maximum": 65535, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Port of gateway listener", 
      "type": "integer"
    }, 
    "protocol": {
      "description": "Specifies the network protocol this listener expects to receive. e.g. HTTP\uff0cHTTPS\uff0cTCP, TLS, UDP.", 
      "enum": [
        "HTTP", 
        "HTTPS", 
        "TCP", 
        "TLS", 
        "UDP"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Protocol of gateway listener", 
      "type": "string"
    }
  }, 
  "title": "Container gateway listener", 
  "type": "object"
}

ContainerInfrastructureInfo (type)

{
  "description": "Details of infrastructure hosting the container cluster e.g. vSphere, AWS, VMC etc..", 
  "id": "ContainerInfrastructureInfo", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "infra_type": {
      "description": "Type of the infrastructure.", 
      "enum": [
        "vSphere", 
        "AWS", 
        "Azure", 
        "Google", 
        "VMC", 
        "KVM", 
        "Baremetal"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Type of the infrastructure", 
      "type": "string"
    }
  }, 
  "title": "Details of container infrastructure", 
  "type": "object"
}

ContainerIngressPolicy (type)

{
  "description": "Details of Container Ingress Policy.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerIngressPolicy", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "container_application_ids": {
      "description": "List of identifiers of the container application , on which ingress policy is applied. e.g. IDs of all services on which the ingress is applied in kubernetes.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Identifiers of the container application", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this ingress policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this container ingress belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Identifier of the container ingress policy.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container ingress policy", 
      "type": "string"
    }, 
    "load_balance_ingress": {
      "description": "Specifies list for ingress points for the load balancer.", 
      "items": {
        "$ref": "ContainerLoadBalancerIngress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of container loadbalancer ingress", 
      "type": "array"
    }, 
    "network_errors": {
      "description": "List of network errors related to container ingress.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container ingress.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container ingress", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ingress in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "Container ingress policy specification.", 
      "readonly": false, 
      "required": false, 
      "title": "Container ingress policy specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Ingress Policy", 
  "type": "object"
}

ContainerIngressPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerIngressPolicyListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerIngressPolicy
      }, 
      "required": true, 
      "title": "List of Container Ingress Policy specs", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerIpPool (type)

{
  "description": "Details of Container Ip Pool.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerIpPool", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "container_cluster_id": {
      "description": "Specifies identifier of the container cluster this container ip pool belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Specifies identifier of the container ip pool.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container ip pool", 
      "type": "string"
    }, 
    "ip_ranges": {
      "description": "Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.", 
      "items": {
        "$ref": "SubnetIpRange
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of IP ranges with subnet details", 
      "type": "array"
    }, 
    "ip_version": {
      "description": "Specifies IP version of container IP pool.", 
      "enum": [
        4, 
        6
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IP version of ContainerIpPool", 
      "type": "integer"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ip pool in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "This specifies yaml definition of ContainerIpPool resource.", 
      "readonly": false, 
      "required": false, 
      "title": "Container ip pool specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Ip Pool", 
  "type": "object"
}

ContainerIpPoolListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerIpPoolListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerIpPool
      }, 
      "required": true, 
      "title": "List of Container IP Pool", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "List request params for the pass through type api that get data from the Antrea Cluster.", 
  "extends": {
    "$ref": "RealizationListRequestParameters
  }, 
  "id": "ContainerListRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cluster_id": {
      "description": "ID of the cluster to query", 
      "required": false, 
      "title": "Cluster ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Realization list request params", 
  "type": "object"
}

ContainerLoadBalancerIngress (type)

{
  "description": "It represents the status of a load-balancer ingress point.", 
  "id": "ContainerLoadBalancerIngress", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "hostname": {
      "description": "Hostname is set for load-balancer ingress points that are DNS based.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Hostname of load-balance ingress point", 
      "type": "string"
    }, 
    "ip": {
      "description": "IP is set for load-balancer ingress points that are IP based.", 
      "format": "ip", 
      "readonly": false, 
      "required": false, 
      "title": "IP of load-balancer ingress point", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports is a list of records of service points.", 
      "items": {
        "$ref": "PortStatus
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of PortStatus", 
      "type": "array"
    }
  }, 
  "title": "Ingress point for load balancer", 
  "type": "object"
}

ContainerNetworkPolicy (type)

{
  "description": "Network policy applied to container.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerNetworkPolicy", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this network policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this network policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "Identifier of the container network policy.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container network policy", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container network policy.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container network policy.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container network policy", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container network policy in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "policy_type": {
      "description": "Type e.g. Network Policy, ASG.", 
      "enum": [
        "NETWORK_POLICY", 
        "ASG", 
        "ACNP", 
        "ANP"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "Container network policy specification.", 
      "readonly": false, 
      "required": false, 
      "title": "Container network policy specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Network Policy", 
  "type": "object"
}

ContainerNetworkPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerNetworkPolicyListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerNetworkPolicy
      }, 
      "required": true, 
      "title": "List of Container Network Policy specs", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerObjectsListRequestParameters (type)

{
  "description": "Request object, containing multiple properties, based on which the result will be filtered. None or multiple properties can be passed as filter criteria. If multiple properties are passed then result will be the intersection of the resultsets by applying each filter individually.", 
  "extends": {
    "$ref": "ContainerClusterFilterParameters
  }, 
  "id": "ContainerObjectsListRequestParameters", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "container_cluster_id": {
      "description": "Identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the container project.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container project", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "scope_id": {
      "description": "Specifies scope id for container cluster. Default value is same as identifier of the cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "Scope id for container cluster", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Container objects list parameters", 
  "type": "object"
}

ContainerProject (type)

{
  "description": "Details of org/namespace within a container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerProject", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster to which this project/namespace belongs.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "description": "External identifier of the container project.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container project", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container project.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container project.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container project", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container project in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container project within a container cluster", 
  "type": "object"
}

ContainerProjectListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ContainerProjectListResult", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ContainerProject
      }, 
      "required": true, 
      "title": "List of projects", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ContainerServicePort (type)

{
  "description": "Specifices details of port exposed by service.", 
  "id": "ContainerServicePort", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "name": {
      "description": "Specifies name of port within the service.", 
      "readonly": false, 
      "required": false, 
      "title": "Name of port", 
      "type": "string"
    }, 
    "node_port": {
      "description": "In case of Kubernetes container cluster, it is port on each node on which the service is exposed, when type of service is NodePort or LoadBalancer.", 
      "maximum": 65535, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Node port of container application", 
      "type": "integer"
    }, 
    "port": {
      "description": "Specifies port exposed by the service", 
      "maximum": 65535, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Port of service", 
      "type": "integer"
    }, 
    "protocol": {
      "description": "Specifies IP protocol of the port. e.g. TCP, UDP, SCTP.", 
      "enum": [
        "TCP", 
        "UDP", 
        "SCTP"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IP protocol of port", 
      "type": "string"
    }, 
    "target_port": {
      "description": "Specifies the number or name of port to access on container application instance by the container application. e.g. It is number or name of port to access of pod by service.", 
      "maxLength": 15, 
      "readony": false, 
      "required": false, 
      "title": "Target port of service", 
      "type": "string"
    }
  }, 
  "title": "Details of service port", 
  "type": "object"
}

ContentFilterValue (type)

{
  "enum": [
    "ALL", 
    "DEFAULT", 
    "REMOVE_CORE_FILES", 
    "EAL4_AUDIT"
  ], 
  "id": "ContentFilterValue", 
  "title": "Support bundle content filter allowed values", 
  "type": "string"
}

ContextProfileAttributesMetadata (type)

{
  "additionalProperties": false, 
  "id": "ContextProfileAttributesMetadata", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "key": {
      "required": true, 
      "title": "Key for metadata", 
      "type": "string"
    }, 
    "value": {
      "required": true, 
      "title": "Value for metadata key", 
      "type": "string"
    }
  }, 
  "title": "Key value structure for holding metadata of context profile attributes", 
  "type": "object"
}

ContinueMigrationRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "ContinueMigrationRequestParameters", 
  "module_id": "Migration", 
  "properties": {
    "skip": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Skip to migration of next component.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ContinueRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "ContinueRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Hints NSX to upgrade a specific component.", 
      "readonly": false, 
      "required": false, 
      "title": "Component to upgrade.", 
      "type": "string"
    }, 
    "skip": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Skip to upgrade of next component.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ControlClusterNodeStatus (type)

{
  "additionalProperties": false, 
  "id": "ControlClusterNodeStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_status": {
      "$ref": "ClusteringStatus, 
      "readonly": true, 
      "title": "Status of this node's connection to the control cluster"
    }, 
    "mgmt_connection_status": {
      "$ref": "MgmtConnStatus, 
      "readonly": true, 
      "title": "Status of this node's management plane connection"
    }
  }, 
  "type": "object"
}

ControlConnStatus (type)

{
  "id": "ControlConnStatus", 
  "module_id": "FabricNode", 
  "properties": {
    "control_node_ip": {
      "readonly": true, 
      "required": true, 
      "title": "IP address of the control Node.", 
      "type": "string"
    }, 
    "failure_status": {
      "enum": [
        "CONNECTION_REFUSED", 
        "INCOMPLETE_HOST_CERT", 
        "INCOMPLETE_CONTROLLER_CERT", 
        "CONTROLLER_REJECTED_HOST_CERT", 
        "HOST_REJECTED_CONTROLLER_CERT", 
        "KEEP_ALIVE_TIMEOUT", 
        "OTHER_SSL_ERROR", 
        "OTHER_ERROR"
      ], 
      "help_detail": "CONNECTION_REFUSED \"Connection refused by control node\"\nINCOMPLETE_HOST_CERT \"Incomplete host certificate\"\nINCOMPLETE_CONTROLLER_CERT \"Incomplete controller certificate\"\nCONTROLLER_REJECTED_HOST_CERT \"Controller rejected host certificate\"\nHOST_REJECTED_CONTROLLER_CERT \"Host rejected controller certificate\"\nKEEP_ALIVE_TIMEOUT \"Keep alive timeout\"\nOTHER_SSL_ERROR \"Other ssl error\"\nOTHER_ERROR \"Other error\".\n", 
      "readonly": true, 
      "required": false, 
      "title": "Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT.", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "help_detail": "UP \"Control node is up\"\nDown \"Control node is down\".\n", 
      "readonly": true, 
      "required": true, 
      "title": "Status of the control Node for e.g  UP, DOWN.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerClusterRoleConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ClusterRoleConfig
  }, 
  "id": "ControllerClusterRoleConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_listen_addr": {
      "$ref": "ServiceEndpoint, 
      "readonly": true, 
      "title": "The IP and port for the control cluster service on this node"
    }, 
    "control_plane_listen_addr": {
      "$ref": "ServiceEndpoint, 
      "readonly": true, 
      "title": "The IP and port for the control plane service on this node"
    }, 
    "host_msg_client_info": {
      "$ref": "MsgClientInfo
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo
    }, 
    "type": {
      "enum": [
        "ManagementClusterRoleConfig", 
        "ControllerClusterRoleConfig"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of this role configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerClusterStatus (type)

{
  "additionalProperties": false, 
  "id": "ControllerClusterStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "status": {
      "enum": [
        "NO_CONTROLLERS", 
        "UNSTABLE", 
        "DEGRADED", 
        "STABLE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "The current status of the controller cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerNodeAggregateInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseNodeAggregateInfo
  }, 
  "id": "ControllerNodeAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "display_name": {
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node_interface_properties": {
      "items": {
        "$ref": "NodeInterfaceProperties
      }, 
      "readonly": true, 
      "title": "Array of Node interface statistic properties", 
      "type": "array"
    }, 
    "node_interface_statistics": {
      "items": {
        "$ref": "NodeInterfaceStatisticsProperties
      }, 
      "readonly": true, 
      "title": "Array of Node network interface statistic properties", 
      "type": "array"
    }, 
    "node_status": {
      "$ref": "ClusterNodeStatus, 
      "readonly": true
    }, 
    "node_status_properties": {
      "items": {
        "$ref": "NodeStatusProperties
      }, 
      "title": "Time series of the node's system properties", 
      "type": "array"
    }, 
    "role_config": {
      "$ref": "ControllerClusterRoleConfig, 
      "readonly": true
    }
  }, 
  "type": "object"
}

ControllerProfilerProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ControllerProfilerProperties", 
  "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"
    }, 
    "enabled": {
      "description": "True for enabling controller profiler, False for disabling controller profiler.", 
      "type": "boolean"
    }
  }, 
  "title": "Controller profiler properties", 
  "type": "object"
}

CookiePersistenceModeType (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "If the persistence cookie is found in the incoming request, value of the cookie is used to identify the server that this request should be sent to. If the cookie is not found, then the server selection algorithm is used to select a new server to handle that request. Three different modes of cookie persistence are supported: insert, prefix and rewrite. In cookie insert mode, a cookie is inserted by load balancer in the HTTP response going from server to client. In cookie prefix and rewrite modes, server controls the cookie and load balancer only manipulates the value of the cookie. In prefix mode, server's cookie value is prepended with the server IP and port and then sent to the client. In rewrite mode, entire server's cookie value is replaced with the server IP and port in the response before sending it to the client.", 
  "enum": [
    "INSERT", 
    "PREFIX", 
    "REWRITE"
  ], 
  "id": "CookiePersistenceModeType", 
  "module_id": "LoadBalancer", 
  "title": "cookie persistence mode", 
  "type": "string"
}

CookieTimeType (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting", 
  "enum": [
    "LbSessionCookieTime", 
    "LbPersistenceCookieTime"
  ], 
  "id": "CookieTimeType", 
  "module_id": "LoadBalancer", 
  "title": "Snat translation type", 
  "type": "string"
}

CopyFromRemoteFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CopyFromRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyRemoteFileProperties (type)

{
  "additionalProperties": {}, 
  "id": "CopyRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyToRemoteFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CopyToRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol, 
      "description": "Only scp and sftp may be used.", 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CoreDumpConfig (type)

{
  "additionalProperties": false, 
  "description": "Node core dump config", 
  "id": "CoreDumpConfig", 
  "properties": {
    "global_file_limit": {
      "default": 2, 
      "minimum": 0, 
      "title": "Core dump file persistence config global limit", 
      "type": "integer"
    }, 
    "global_frequency_threshold": {
      "default": 600, 
      "minimum": 0, 
      "title": "Core dump files frequency threshold config in seconds, set 0 to disable\n", 
      "type": "integer"
    }, 
    "process_config": {
      "items": {
        "$ref": "CoreDumpProcessConfig
      }, 
      "title": "Core dump config per process limit", 
      "type": "array"
    }
  }, 
  "title": "Node core dump config", 
  "type": "object"
}

CoreDumpProcessConfig (type)

{
  "id": "CoreDumpProcessConfig", 
  "properties": {
    "limit": {
      "required": true, 
      "title": "Core dump process limit", 
      "type": "integer"
    }, 
    "process_name": {
      "required": true, 
      "title": "Core dump process name", 
      "type": "string"
    }
  }, 
  "title": "Core dump process config", 
  "type": "object"
}

CorfuCertificateExpiryCheckProperties (type)

{
  "additionalProperties": false, 
  "id": "CorfuCertificateExpiryCheckProperties", 
  "module_id": "ComplianceReporter", 
  "properties": {
    "status": {
      "required": true, 
      "title": "Current Status of Corfu Certificate Expiry Check (enabled/disabled)", 
      "type": "string"
    }
  }, 
  "title": "Corfu Certificate Expiry Check Properties", 
  "type": "object"
}

CpuCoreConfigForEnhancedNetworkingStackSwitch (type) (Deprecated)

{
  "deprecated": true, 
  "description": "Non Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.", 
  "id": "CpuCoreConfigForEnhancedNetworkingStackSwitch", 
  "module_id": "TransportNode", 
  "properties": {
    "num_lcores": {
      "minimum": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node", 
      "type": "int"
    }, 
    "numa_node_index": {
      "minimum": 0, 
      "readonly": false, 
      "required": true, 
      "title": "Unique index of the Non Uniform Memory Access (NUMA) node", 
      "type": "int"
    }
  }, 
  "title": "Enhanced Networking Stack CPU configuration", 
  "type": "object"
}

CpuStats (type)

{
  "additionalProperties": false, 
  "id": "CpuStats", 
  "properties": {
    "core": {
      "description": "CPU id", 
      "readonly": true, 
      "title": "core id", 
      "type": "string"
    }, 
    "cpu_type": {
      "default": "controlpath_core", 
      "description": "cpu type, one of datapath_core, controlpath_core and service_core", 
      "enum": [
        "datapath_core", 
        "controlpath_core", 
        "service_core"
      ], 
      "readonly": true, 
      "title": "cpu type", 
      "type": "string"
    }, 
    "crypto": {
      "description": "CPU crypto usage(pps)", 
      "readonly": true, 
      "title": "CPU crypto usage", 
      "type": "string"
    }, 
    "intercore": {
      "description": "CPU intercore usage(pps)", 
      "readonly": true, 
      "title": "CPU intercore usage", 
      "type": "string"
    }, 
    "kni": {
      "description": "CPU kni usage(pps)", 
      "readonly": true, 
      "title": "CPU kni usage", 
      "type": "string"
    }, 
    "mega_flowcachestats": {
      "$ref": "FlowCacheStatistics, 
      "description": "Mega Flow cache statistics. All flow cache stats would be reset on Datapath restart.", 
      "readonly": true, 
      "title": "Flow cache stats", 
      "type": "object"
    }, 
    "micro_flowcachestats": {
      "$ref": "FlowCacheStatistics, 
      "description": "Micro Flow cache statistics. All flow cache stats would be reset on Datapath restart.", 
      "readonly": true, 
      "title": "Flow cache stats", 
      "type": "object"
    }, 
    "packet_processing_usage": {
      "description": "Datapath CPU packet processing usage(%)", 
      "readonly": true, 
      "title": "Datapath CPU packet processing usage", 
      "type": "string"
    }, 
    "rx": {
      "description": "CPU rx usage(pps)", 
      "readonly": true, 
      "title": "CPU rx usage", 
      "type": "string"
    }, 
    "slowpath": {
      "description": "CPU slowpath usage(pps)", 
      "readonly": true, 
      "title": "CPU slowpath usage", 
      "type": "string"
    }, 
    "tx": {
      "description": "CPU tx usage(pps)", 
      "readonly": true, 
      "title": "CPU tx usage", 
      "type": "string"
    }, 
    "usage": {
      "description": "CPU usage(%)", 
      "readonly": true, 
      "title": "CPU usage", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CpuUsage (type)

{
  "additionalProperties": false, 
  "id": "CpuUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "avg_cpu_core_usage_dpdk": {
      "description": "Indicates the average usage of all DPDK cores in percentage.", 
      "readonly": true, 
      "title": "Average utilization of all DPDK cores", 
      "type": "number"
    }, 
    "avg_cpu_core_usage_non_dpdk": {
      "description": "Indicates the average usage of all non-DPDK cores in percentage.", 
      "readonly": true, 
      "title": "Average usage of all non-DPDK cores", 
      "type": "number"
    }, 
    "highest_cpu_core_usage_dpdk": {
      "description": "Indicates the highest CPU utilization value among DPDK cores in percentage.", 
      "readonly": true, 
      "title": "Highest CPU utilization value among DPDK cores", 
      "type": "number"
    }, 
    "highest_cpu_core_usage_non_dpdk": {
      "description": "Indicates the highest cpu utilization value among non_dpdk cores in percentage.", 
      "readonly": true, 
      "title": "Highest CPU utilization value among non-DPDK cores", 
      "type": "number"
    }
  }, 
  "title": "CPU usage of DPDK and non-DPDK cores", 
  "type": "object"
}

CreateRemoteDirectoryProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CreateRemoteDirectoryProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "SftpProtocol, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Criterion (type)

{
  "additionalProperties": false, 
  "description": "Event Criterion is the logical evaluations by which the event may be deemed fulfilled. All the evaluations must be met in order for the criterion to be met (implicit AND).", 
  "id": "Criterion", 
  "module_id": "PolicyReaction", 
  "properties": {
    "evaluations": {
      "description": "Criterion Evaluations.", 
      "items": {
        "$ref": "Evaluation
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Criterion Evaluations", 
      "type": "array"
    }
  }, 
  "title": "Event Criterion", 
  "type": "object"
}

Crl (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Crl", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "crl_type": {
      "default": "X509", 
      "description": "The type of the CRL. It can be \"OneCRL\" or \"X509\" (default).", 
      "enum": [
        "OneCRL", 
        "X509"
      ], 
      "required": false, 
      "title": "Type of CRL", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "$ref": "X509Crl, 
      "description": "Details of the X509Crl object.", 
      "readonly": true, 
      "required": false
    }, 
    "details_revoked_by_issuer_and_serial_number": {
      "items": {
        "$ref": "IssuerSerialNumber
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Certificates revoked by issuer and serial number", 
      "type": "array"
    }, 
    "details_revoked_by_subject_and_public_key_hash": {
      "items": {
        "$ref": "SubjectPublicKeyHash
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Certificates revoked by subject and public key hash", 
      "type": "array"
    }, 
    "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"
    }, 
    "one_crl": {
      "readonly": false, 
      "required": false, 
      "title": "JSON-encoded OneCRL-like object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "PEM encoded CRL data.", 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CrlDistributionPoint (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CrlDistributionPoint", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "cdp_uri": {
      "description": "CRL Distribution Point URI where to fetch the CRL.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "CDP URI", 
      "type": "string"
    }, 
    "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"
    }, 
    "issuer": {
      "description": "Issuer of the CRL, referring to the CA.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Issuer", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Reference to a CRL Distribution Point where to fetch a CRL", 
  "type": "object"
}

CrlDistributionPointList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CrlDistributionPointList", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CrlDistributionPoint list.", 
      "items": {
        "$ref": "CrlDistributionPoint
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CrlDistributionPoint query result", 
  "type": "object"
}

CrlDistributionPointStatus (type)

{
  "additionalProperties": false, 
  "id": "CrlDistributionPointStatus", 
  "module_id": "CertificateManager", 
  "properties": {
    "error_message": {
      "description": "Error message when fetching the CRL failed.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "status": {
      "$ref": "CdpStatusType, 
      "description": "Status of the fetched CRL for this CrlDistributionPoint", 
      "readonly": true, 
      "required": true, 
      "title": "Status"
    }
  }, 
  "title": "Reference to a CRL Distribution Point where to fetch a CRL", 
  "type": "object"
}

CrlList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CrlList", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CRL list.", 
      "items": {
        "$ref": "Crl
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Crl queries result", 
  "type": "object"
}

CrlObjectData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CrlObjectData", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "crl_type": {
      "default": "X509", 
      "description": "The type of the CRL. It can be \"OneCRL\" or \"X509\" (default).", 
      "enum": [
        "OneCRL", 
        "X509"
      ], 
      "required": false, 
      "title": "Type of CRL", 
      "type": "string"
    }, 
    "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"
    }, 
    "one_crl": {
      "readonly": false, 
      "required": false, 
      "title": "JSON-encoded OneCRL-like object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "PEM encoded CRL data.", 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CrlPemRequestType (type)

{
  "additionalProperties": false, 
  "id": "CrlPemRequestType", 
  "module_id": "CertificateManager", 
  "properties": {
    "cdp_uri": {
      "description": "CRL Distribution Point URI where to fetch the CRL.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "CDP URI", 
      "type": "string"
    }
  }, 
  "title": "Request Type to get a CRL's PEM file.", 
  "type": "object"
}

CrossSiteFlowInfo (type)

{
  "description": "Represents details of the config flow between sites. Federation has the following flows - Global Manager to Local Manager (GM -> LM) - Local Manager to Glocal Manager (LM -> GM) - Global Manager Active to Glocal Manager Standby (GM -> GM) - Local Manager to Local Manager (LM -> LM)", 
  "id": "CrossSiteFlowInfo", 
  "module_id": "FederationObservability", 
  "properties": {
    "from_site_id": {
      "read_only": true, 
      "title": "Site id of the source", 
      "type": "string"
    }, 
    "from_site_path": {
      "read_only": true, 
      "title": "Source site policy path", 
      "type": "string"
    }, 
    "full_sync_info": {
      "$ref": "FullSyncInfo, 
      "read_only": true, 
      "title": "Full sync information for the flow"
    }, 
    "latency_measured_ts": {
      "read_only": true, 
      "title": "Timestamp of latency measurement", 
      "type": "integer"
    }, 
    "latency_millis": {
      "read_only": true, 
      "title": "Latency from source to destination site in milli seconds", 
      "type": "integer"
    }, 
    "leader_node_id": {
      "read_only": true, 
      "title": "Local leader node id sharded for this remote site.", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "GOOD", 
        "DISCONNECTED", 
        "RECOVERY", 
        "ERROR", 
        "UNKNOWN", 
        "NOT_READY"
      ], 
      "read_only": true, 
      "title": "Overall status of the flow", 
      "type": "string"
    }, 
    "to_site_id": {
      "read_only": true, 
      "title": "Site id of the destination", 
      "type": "string"
    }, 
    "to_site_path": {
      "read_only": true, 
      "title": "Destination site policy path", 
      "type": "string"
    }
  }, 
  "title": "Information about config flow in federation", 
  "type": "object"
}

CryptoAlgorithm (type)

{
  "additionalProperties": false, 
  "id": "CryptoAlgorithm", 
  "module_id": "CertificateManager", 
  "properties": {
    "key_size": {
      "description": "Supported key sizes for the algorithm.", 
      "items": {
        "$ref": "KeySize
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "name": {
      "description": "Crypto algorithm name.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

CryptoEnforcement (type)

{
  "additionalProperties": false, 
  "description": "If enforced and if TLS protocol Client/Server Hello has none of the permitted TLS versions or ciphers then the connection is immediately terminated.", 
  "enum": [
    "ENFORCE", 
    "TRANSPARENT"
  ], 
  "help_summary": "Use of 'ENFORCE' will terminate connection if TLS protocol Client/Server Hello has\nnone of the permitted TLS versions or ciphers.\nUse of 'TRANSPARENT' will let client's and server's own choices use for TLS\nversions and ciphers to successfully intercept the connection.\n", 
  "id": "CryptoEnforcement", 
  "module_id": "PolicyTlsActionProfile", 
  "readonly": true, 
  "required": false, 
  "title": "Action for crypto enforcement", 
  "type": "string"
}

CsmStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CsmStatus", 
  "module_id": "CloudServiceManager", 
  "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"
    }, 
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the Csm instance", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the Csm appliance", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the Csm appliance", 
      "type": "string"
    }, 
    "ip_address": {
      "readonly": true, 
      "required": false, 
      "title": "IP address of Csm instance", 
      "type": "string"
    }, 
    "managed_by_vmware": {
      "description": "This property is used only if CSM is running in service mode", 
      "readonly": true, 
      "required": false, 
      "title": "Mode of running of Csm instance", 
      "type": "boolean"
    }, 
    "supported_clouds": {
      "description": "This property provides the list of names of supported clouds by CSM.", 
      "items": {
        "$ref": "CloudTypeInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Indication of clouds supported by CSM", 
      "type": "array"
    }, 
    "version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of Csm", 
      "type": "string"
    }
  }, 
  "title": "Information about status of cloud service manager", 
  "type": "object"
}

CsmSupportedRegions (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CsmSupportedRegions", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "cloud_type": {
      "enum": [
        "AWS", 
        "AZURE", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST", 
        "AZURE_GOV_US"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Type of cloud", 
      "type": "string"
    }, 
    "supported_regions": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of supported regions on the type of cloud", 
      "type": "array"
    }
  }, 
  "title": "Csm supported regions for cloud type", 
  "type": "object"
}

CsmSupportedRegionsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CsmSupportedRegionsListResult", 
  "module_id": "CloudAccounts", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CsmSupportedRegions
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of supported regions per cloud type", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of all Csm supported regions per cloud type", 
  "type": "object"
}

CsmSystemConfig (type)

{
  "additionalProperties": false, 
  "description": "CSM deploys Gateway (PCG) in the cloud, CSM mgmt IP may or may not be the same as the IP exposed to PCG. Configuring the IP CIDRs that are exposed to the PCG (after NAT) would allow CSM to configure cloud gateway security group to be only accessed via appropriate IP CIDRs.", 
  "id": "CsmSystemConfig", 
  "module_id": "CSMSystemManagement", 
  "properties": {
    "mgmt_ip_config": {
      "items": {
        "$ref": "CidrBlock
      }, 
      "required": false, 
      "title": "List of management IP CIDRs.", 
      "type": "array"
    }
  }, 
  "title": "CSM system management configuration information", 
  "type": "object"
}

CsmVpnEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Details of a CSM VPN endpoint which can either be an AWS VPC or an Azure VNET managed by NSX", 
  "id": "CsmVpnEndpoint", 
  "module_id": "CsmVpnInformation", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name for the CSM VPN endpoint", 
      "type": "string"
    }, 
    "endpoint_type": {
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of endpoint like AWS, Azure or other supported clouds", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique identifier for the CSM VPN endpoint", 
      "type": "string"
    }
  }, 
  "title": "NSX managed CSM VPN endpoint", 
  "type": "object"
}

CsmVpnEndpointsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These parameters can be used to filter the list of CSM VPN endpoints. Multiple parameters can be given as input. Different parameters are implicitly 'AND'ed.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "CsmVpnEndpointsListRequestParameters", 
  "module_id": "CsmVpnInformation", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "endpoint_type": {
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "required": false, 
      "title": "Endpoint type based on which the CSM VPN endpoints list is to be filtered", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsmVpnEndpointsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CsmVpnEndpointsListResult", 
  "module_id": "CsmVpnInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CsmVpnEndpoint
      }, 
      "required": false, 
      "title": "NSX managed CSM VPN endpoints", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of NSX managed CSM VPN endpoints", 
  "type": "object"
}

CsmVpnSession (type)

{
  "additionalProperties": false, 
  "description": "Details of a CSM VPN session like name, source and destination endpoints", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "CsmVpnSession", 
  "module_id": "CsmVpnInformation", 
  "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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_endpoint": {
      "$ref": "CsmVpnEndpoint, 
      "description": "Destination endpoint of the CSM VPN session can be a cloud endpoint like AWS VPC, Azure VNET managed by NSX.", 
      "required": true, 
      "title": "Destination endpoint of the CSM VPN session"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_endpoint": {
      "$ref": "CsmVpnEndpoint, 
      "description": "Source endpoint of the CSM VPN session can be a cloud endpoint like AWS VPC, Azure VNET managed by NSX.", 
      "required": true, 
      "title": "Source endpoint of the CSM VPN session"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "CSM VPN session details", 
  "type": "object"
}

CsmVpnSessionStatus (type)

{
  "additionalProperties": false, 
  "description": "Status and details of a CSM VPN session", 
  "id": "CsmVpnSessionStatus", 
  "module_id": "CsmVpnInformation", 
  "properties": {
    "details": {
      "$ref": "CsmVpnSession, 
      "description": "Details of the CSM VPN session with endpoints and the status of the session.", 
      "readonly": true, 
      "required": true, 
      "title": "CSM VPN session details"
    }, 
    "state": {
      "enum": [
        "DOWN", 
        "UP", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Realized state of the CSM VPN session", 
      "type": "string"
    }, 
    "status_message": {
      "readonly": true, 
      "required": false, 
      "title": "Detailed status message of the CSM VPN session", 
      "type": "string"
    }
  }, 
  "title": "CSM VPN session status and details", 
  "type": "object"
}

CsmVpnSessionStatusListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These parameters can be used to filter the list of CSM VPN sessions statuses. Multiple parameters can be given as input. Different parameters are implicitly 'AND'ed.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "CsmVpnSessionStatusListRequestParameters", 
  "module_id": "CsmVpnInformation", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "refresh": {
      "default": false, 
      "required": false, 
      "title": "Flag to fetch the updated list of CSM VPN sessions statuses", 
      "type": "boolean"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "DOWN", 
        "UP", 
        "IN_PROGRESS"
      ], 
      "required": false, 
      "title": "CSM VPN session realized state based on which the CSM VPN sessions list is to be filtered\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsmVpnSessionStatusListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CsmVpnSessionStatusListResult", 
  "module_id": "CsmVpnInformation", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CsmVpnSessionStatus
      }, 
      "required": false, 
      "title": "List of CSM VPN sessions statuses", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "CSM VPN sessions status list", 
  "type": "object"
}

CspConfig (type)

{
  "description": "Extra OIDC configuration relevant only for CSP endpoints.", 
  "id": "CspConfig", 
  "module_id": "CertificateManager", 
  "properties": {
    "additional_org_ids": {
      "description": "A list of organization IDs. CSP tokens must be associated with one of these organizations, or the customer_org_id, in order to be considered valid.", 
      "items": {
        "type": "string"
      }, 
      "title": "Additional orginzation IDs", 
      "type": "array"
    }, 
    "customer_org_id": {
      "descrpition": "The ID of the customer organization.", 
      "title": "Customer organization ID", 
      "type": "string"
    }
  }, 
  "title": "CSP authentication configuration", 
  "type": "object"
}

Csr (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Csr", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "algorithm": {
      "default": "RSA", 
      "description": "Cryptographic algorithm (asymmetric) used by the public key for data encryption.", 
      "enum": [
        "RSA", 
        "EC"
      ], 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "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"
    }, 
    "is_ca": {
      "default": false, 
      "description": "Whether the CSR is for a CA certificate.", 
      "required": false, 
      "type": "boolean"
    }, 
    "key_size": {
      "default": 4096, 
      "description": "Size measured in bits of the public key used in a cryptographic algorithm.", 
      "readonly": false, 
      "required": false, 
      "type": "integer"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subject": {
      "$ref": "Principal, 
      "description": "The certificate owner's information. (CN, O, OU, C, ST, L)", 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CsrExt (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Csr
  }, 
  "id": "CsrExt", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "algorithm": {
      "default": "RSA", 
      "description": "Cryptographic algorithm (asymmetric) used by the public key for data encryption.", 
      "enum": [
        "RSA", 
        "EC"
      ], 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "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"
    }, 
    "extensions": {
      "$ref": "CsrExtensions, 
      "description": "X509 v3 extensions to be added to a CSR.", 
      "readonly": true, 
      "required": false, 
      "title": "X509 extensions to add"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_ca": {
      "default": false, 
      "description": "Whether the CSR is for a CA certificate.", 
      "required": false, 
      "type": "boolean"
    }, 
    "key_size": {
      "default": 4096, 
      "description": "Size measured in bits of the public key used in a cryptographic algorithm.", 
      "readonly": false, 
      "required": false, 
      "type": "integer"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subject": {
      "$ref": "Principal, 
      "description": "The certificate owner's information. (CN, O, OU, C, ST, L)", 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Extended certificate signing request body", 
  "type": "object"
}

CsrExtensions (type)

{
  "additionalProperties": false, 
  "id": "CsrExtensions", 
  "module_id": "CertificateManager", 
  "properties": {
    "subject_alt_names": {
      "$ref": "SubjectAltNames, 
      "description": "Subject alternative names of the CSR", 
      "readonly": true, 
      "required": false, 
      "title": "Subject alternative names"
    }
  }, 
  "title": "Collection of various x509 v3 extensions to be added to a CSR", 
  "type": "object"
}

CsrList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CsrList", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CSR list.", 
      "items": {
        "$ref": "Csr
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Csr queries result", 
  "type": "object"
}

CsrWithDaysValid (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Csr
  }, 
  "id": "CsrWithDaysValid", 
  "module_id": "CertificateManager", 
  "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"
    }, 
    "algorithm": {
      "default": "RSA", 
      "description": "Cryptographic algorithm (asymmetric) used by the public key for data encryption.", 
      "enum": [
        "RSA", 
        "EC"
      ], 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "days_valid": {
      "default": 825, 
      "maximum": 10000, 
      "minimum": 1, 
      "title": "Number of days the certificate will be valid, default 825 days", 
      "type": "integer"
    }, 
    "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"
    }, 
    "is_ca": {
      "default": false, 
      "description": "Whether the CSR is for a CA certificate.", 
      "required": false, 
      "type": "boolean"
    }, 
    "key_size": {
      "default": 4096, 
      "description": "Size measured in bits of the public key used in a cryptographic algorithm.", 
      "readonly": false, 
      "required": false, 
      "type": "integer"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subject": {
      "$ref": "Principal, 
      "description": "The certificate owner's information. (CN, O, OU, C, ST, L)", 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "CSR data with days valid", 
  "type": "object"
}

CsvListResult (type)

{
  "abstract": true, 
  "description": "Base type for CSV result.", 
  "id": "CsvListResult", 
  "module_id": "CsvTypes", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsvRecord (type)

{
  "abstract": true, 
  "description": "Base type for CSV records.", 
  "id": "CsvRecord", 
  "module_id": "CsvTypes", 
  "type": "object"
}

CurrentBackupOperationStatus (type)

{
  "additionalProperties": false, 
  "id": "CurrentBackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": false, 
      "title": "Unique identifier of current backup", 
      "type": "string"
    }, 
    "current_step": {
      "enum": [
        "BACKUP_CREATING_CLUSTER_BACKUP", 
        "BACKUP_CREATING_NODE_BACKUP"
      ], 
      "required": false, 
      "title": "Current step of operation", 
      "type": "string"
    }, 
    "current_step_message": {
      "required": false, 
      "title": "Additional human-readable status information about current step", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation is expected to end"
    }, 
    "operation_type": {
      "enum": [
        "NONE", 
        "BACKUP"
      ], 
      "required": false, 
      "title": "Type of operation that is in progress. Returns none if no operation is in progress, in which case\nnone of the other fields will be set.\n", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was started"
    }
  }, 
  "title": "Current backup operation status", 
  "type": "object"
}

CurrentRealizationStateBarrier (type)

{
  "description": "The current global barrier number of the realized state", 
  "id": "CurrentRealizationStateBarrier", 
  "module_id": "RealizationStateBarrier", 
  "properties": {
    "current_barrier_number": {
      "description": "Gives the current global barrier number for NSX", 
      "readonly": true, 
      "required": true, 
      "type": "integer"
    }
  }, 
  "type": "object"
}

CustomAttributeAction (type)

{
  "additionalProperties": false, 
  "description": "Request Parameter which specify action to either add or remove the custom values.", 
  "id": "CustomAttributeAction", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "action": {
      "description": "Action parameter determines whether to add or remove Custom Context Profile Attribute values.", 
      "enum": [
        "add", 
        "remove"
      ], 
      "required": true, 
      "title": "Add or Remove Custom Context Profile Attribute values.", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Custom Context Profile Attributes", 
  "type": "object"
}

CustomFilterWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for custom filter widget. For this widget the data source is not applicable. It defines ui identifer for filter UI component and render it on dashboard view. This configuration can only be used for system owned widgets.", 
  "extends": {
    "$ref": "FilterWidgetConfiguration
  }, 
  "id": "CustomFilterWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CustomFilterWidgetConfiguration"
  }, 
  "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"
    }, 
    "alias": {
      "description": "Alias to be used when emitting filter value.", 
      "title": "Alias to be used when emitting filter value", 
      "type": "string"
    }, 
    "condition": {
      "description": "If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "deprecated": true, 
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "filters": {
      "description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "A List of filter ids applied to this widget configuration", 
      "type": "array"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "plot_configs": {
      "description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.", 
      "items": {
        "$ref": "WidgetPlotConfiguration
      }, 
      "required": false, 
      "title": "List of plotting configuration for a given widget.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "CustomFilterWidgetConfiguration", 
        "TimeRangeDropdownFilterWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration", 
        "SpacerWidgetConfiguration", 
        "LegendWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "rowspan": {
      "description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.", 
      "minimum": 1, 
      "title": "Vertical span", 
      "type": "int"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "show_header": {
      "description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.", 
      "title": "This decides to show the container header or not.", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "ui_component_identifier": {
      "description": "User defined filter component selector to be rendered inside view/container.", 
      "required": true, 
      "title": "UI identifier for filter component to be rendered inside view/container", 
      "type": "string"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Custom Filter widget Configuration", 
  "type": "object"
}

CustomWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for custom widget. For this widget the data source is not applicable. It defines ui identifer to identify UI component and render it on dashboard view. This configuration can only be used for system owned widgets.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "CustomWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CustomWidgetConfiguration"
  }, 
  "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"
    }, 
    "condition": {
      "description": "If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "deprecated": true, 
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "filters": {
      "description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "A List of filter ids applied to this widget configuration", 
      "type": "array"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "plot_configs": {
      "description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.", 
      "items": {
        "$ref": "WidgetPlotConfiguration
      }, 
      "required": false, 
      "title": "List of plotting configuration for a given widget.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "CustomFilterWidgetConfiguration", 
        "TimeRangeDropdownFilterWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration", 
        "SpacerWidgetConfiguration", 
        "LegendWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "rowspan": {
      "description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.", 
      "minimum": 1, 
      "title": "Vertical span", 
      "type": "int"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "show_header": {
      "description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.", 
      "title": "This decides to show the container header or not.", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "ui_component_identifier": {
      "description": "User defined component selector to be rendered inside view/container.", 
      "title": "UI identifier for component to be rendered inside view/container", 
      "type": "string"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Custom widget Configuration", 
  "type": "object"
}

CvxConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to a CVX type of enforcement point.", 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo
  }, 
  "id": "CvxConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CvxConnectionInfo"
  }, 
  "properties": {
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "password": {
      "description": "Password.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo", 
        "AviConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.", 
      "required": false, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "description": "Username.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "secure_string"
    }
  }, 
  "title": "CVX Connection Info", 
  "type": "object"
}

DADMode (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection modes.", 
  "enum": [
    "LOOSE", 
    "STRICT"
  ], 
  "id": "DADMode", 
  "module_id": "Routing", 
  "title": "DAD Mode", 
  "type": "string"
}

DADProfile (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection profile.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DADProfile", 
  "module_id": "Routing", 
  "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"
    }, 
    "dad_mode": {
      "$ref": "DADMode, 
      "default": "LOOSE", 
      "required": false, 
      "title": "DAD Mode"
    }, 
    "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"
    }, 
    "ns_retries": {
      "default": 3, 
      "description": "Number of Neighbor solicitation packets generated before completing the Duplicate address detection process.", 
      "maximum": 10, 
      "minimum": 0, 
      "required": false, 
      "title": "NS retries count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "wait_time": {
      "default": 1, 
      "description": "The time duration in seconds, to wait for Neighbor advertisement after sending the Neighbor solicitation message.", 
      "maximum": 60, 
      "minimum": 0, 
      "required": false, 
      "title": "Wait time", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DADProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DADProfileListResult", 
  "module_id": "Routing", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DADProfile
      }, 
      "required": true, 
      "title": "Paginated list of DADProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DADStatus (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection status for IP address on port.", 
  "enum": [
    "DUPLICATED", 
    "TENTATIVE", 
    "ASSIGNED", 
    "NOT_APPLICABLE", 
    "UNKNOWN"
  ], 
  "id": "DADStatus", 
  "module_id": "LogicalRouterPorts", 
  "title": "DAD Status", 
  "type": "string"
}

DHGroup (type)

{
  "additionalProperties": false, 
  "description": "Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1024-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group. GROUP19 uses 256-bit random Elliptic Curve (ECP) group. GROUP20 uses 384-bit random ECP group. GROUP21 uses 521-bit random ECP group.", 
  "enum": [
    "GROUP2", 
    "GROUP5", 
    "GROUP14", 
    "GROUP15", 
    "GROUP16", 
    "GROUP19", 
    "GROUP20", 
    "GROUP21"
  ], 
  "id": "DHGroup", 
  "module_id": "IPSecVPN", 
  "title": "Diffie-Hellman groups", 
  "type": "string"
}

DNSForwarderStatisticsPerEnforcementPoint (type)

{
  "abstract": true, 
  "description": "DNS forwarder statistics per enforcement point.", 
  "id": "DNSForwarderStatisticsPerEnforcementPoint", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the statistics are fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatistics"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DNS forwarder statistics per enforcement point", 
  "type": "object"
}

DNSForwarderStatusPerEnforcementPoint (type)

{
  "abstract": true, 
  "description": "DNS forwarder status per enforcement point.", 
  "id": "DNSForwarderStatusPerEnforcementPoint", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the status is fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatus"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DNS forwarder status per enforcement point", 
  "type": "object"
}

DSAppliedToType (type)

{
  "enum": [
    "NSGroup", 
    "LogicalSwitch", 
    "LogicalRouter", 
    "LogicalPort"
  ], 
  "id": "DSAppliedToType", 
  "module_id": "DistributedServices", 
  "title": "Resource type valid for use as AppliedTo filter in section API", 
  "type": "string"
}

DSExcludeList (type)

{
  "abstract": true, 
  "description": "List of entities excluded for enforcing a service or a feature.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DSExcludeList", 
  "module_id": "DistributedServices", 
  "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"
    }, 
    "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"
    }, 
    "member_count": {
      "description": "Total number of members present in Exclude List.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Member Count", 
      "type": "integer"
    }, 
    "members": {
      "description": "List of members in Exclusion List", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "maxItems": 1000, 
      "readonly": false, 
      "required": true, 
      "title": "Member list", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Exclusion List", 
  "type": "object"
}

DSInsertParameters (type)

{
  "abstract": true, 
  "id": "DSInsertParameters", 
  "module_id": "DistributedServices", 
  "properties": {
    "id": {
      "maxLength": 64, 
      "required": false, 
      "title": "Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.", 
      "type": "string"
    }, 
    "operation": {
      "default": "insert_top", 
      "enum": [
        "insert_top", 
        "insert_bottom", 
        "insert_after", 
        "insert_before"
      ], 
      "required": false, 
      "title": "Operation", 
      "type": "string"
    }
  }, 
  "title": "Parameters to tell where rule/section need to be added. All the params take rule/section Id.", 
  "type": "object"
}

DSListRequestParameters (type)

{
  "abstract": true, 
  "description": "Pagination and Filtering parameters to get only a subset of sections/rules.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DSListRequestParameters", 
  "module_id": "DistributedServices", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type 'FILTER' will ensure all criterias (sources, destinations, services, extended sources, context profiles, appliedtos) are matched. Type 'SEARCH' will match any of the given criteria.", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of sections/rules.", 
  "type": "object"
}

DSRule (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "EmbeddedResource
  }, 
  "id": "DSRule", 
  "module_id": "DistributedServices", 
  "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"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_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"
    }, 
    "action": {
      "description": "Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW           - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP            - Drop any packet when a rule with this action gets a match. Packets won't go further(Used by Firewall). REJECT          - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT        - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DETECT          - Detect IDS Signatures. ALLOW_CONTINUE  - Allows rules to jump from this rule. Action on matching rules in the destination category will decide next step. Application is default destination until new categories are supported to jump to. DETECT_PREVENT  - Detect and Prevent IDS Signatures.", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT", 
        "REDIRECT", 
        "DO_NOT_REDIRECT", 
        "DETECT", 
        "ALLOW_CONTINUE", 
        "DETECT_PREVENT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Action", 
      "type": "string"
    }, 
    "applied_tos": {
      "description": "List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of the destinations. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "Negation of the destination.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Rule direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": false, 
      "required": false, 
      "title": "Rule enable/disable flag", 
      "type": "boolean"
    }, 
    "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": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ip_protocol": {
      "default": "IPV4_IPV6", 
      "description": "Type of IP packet that should be matched while enforcing the rule.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "Flag to indicate whether rule is default.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "User notes specific to the rule.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Notes", 
      "type": "string"
    }, 
    "priority": {
      "description": "Priority of the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule priority", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "readonly": false, 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "Negation of the source.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

DSRuleState (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Rule Realization State", 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DSRuleState", 
  "module_id": "DistributedServices", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "description": "This attribute represents revision number of rule's desired state.", 
      "readonly": true, 
      "required": false, 
      "title": "Desired state revision number", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Rule Realization State", 
  "type": "object"
}

DSSection (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DSSection", 
  "module_id": "DistributedServices", 
  "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"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "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"
    }, 
    "is_default": {
      "description": "It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT", 
        "IDS"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DSSectionListResult (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DSSectionListResult", 
  "module_id": "DistributedServices", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DSSectionQueryParameters (type)

{
  "abstract": true, 
  "id": "DSSectionQueryParameters", 
  "module_id": "DistributedServices", 
  "properties": {
    "cascade": {
      "default": false, 
      "required": false, 
      "title": "Flag to cascade delete of this object to all it's child objects.", 
      "type": "boolean"
    }
  }, 
  "title": "Section query parameters", 
  "type": "object"
}

DSSectionState (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Section Realization Status", 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DSSectionState", 
  "module_id": "DistributedServices", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "description": "This attribute represents revision number of section's desired state.", 
      "readonly": true, 
      "required": false, 
      "title": "Section's desired state revision number", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Section Realization State", 
  "type": "object"
}

DSService (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ResourceReference
  }, 
  "id": "DSService", 
  "module_id": "DistributedServices", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "NSServiceElement, 
      "description": "Distributed Service API accepts raw protocol and ports as part of NS service element in Distributed Service Rule that describes traffic corresponding to an NSService.", 
      "readonly": false, 
      "required": false, 
      "title": "Distributed Service Network and Security Service element"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DVSConfig (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DVSConfig", 
  "module_id": "DistributedVirtualSwitch", 
  "properties": {
    "host_infra_traffic_res": {
      "description": "host_infra_traffic_res specifies bandwidth allocation for various traffic resources.", 
      "items": {
        "$ref": "ResourceAllocation
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Resource allocation associated with NiocProfile", 
      "type": "array"
    }, 
    "lacp_group_configs": {
      "description": "It contains information about VMware specific multiple dynamic LACP groups.", 
      "items": {
        "$ref": "LacpGroupConfigInfo
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Array of Link Aggregation Control Protocol (LACP) configuration", 
      "type": "array"
    }, 
    "lldp_send_enabled": {
      "default": false, 
      "required": false, 
      "title": "Enabled or disabled sending LLDP packets", 
      "type": "boolean"
    }, 
    "mtu": {
      "minimum": 1600, 
      "required": false, 
      "title": "Maximum Transmission Unit used for uplinks", 
      "type": "int"
    }, 
    "name": {
      "readonly": false, 
      "required": true, 
      "title": "The DVS name", 
      "type": "string"
    }, 
    "uplink_port_names": {
      "description": "Names of uplink ports for this DVS.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Uplink port names", 
      "type": "array"
    }, 
    "uuid": {
      "readonly": false, 
      "required": false, 
      "title": "The DVS uuid", 
      "type": "string"
    }
  }, 
  "title": "The DVS Configuration", 
  "type": "object"
}

DailyTelemetrySchedule (type)

{
  "extends": {
    "$ref": "TelemetrySchedule
  }, 
  "id": "DailyTelemetrySchedule", 
  "module_id": "TelemetryConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DailyTelemetrySchedule"
  }, 
  "properties": {
    "frequency_type": {
      "description": "Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.", 
      "required": true, 
      "title": "Frequency at which data will be collected", 
      "type": "string"
    }, 
    "hour_of_day": {
      "description": "Hour at which data will be collected. Specify a value between 0 through 23.", 
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Hour at which data will be collected", 
      "type": "integer"
    }, 
    "minutes": {
      "default": 0, 
      "description": "Minute at which data will be collected. Specify a value between 0 through 59.", 
      "maximum": 59, 
      "minimum": 0, 
      "required": false, 
      "title": "Minute at which data will be collected", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DashboardSummaryListRequestQueryParameters (type)

{
  "description": "Represents the query parameters, such as the tenancy context and the pagination properties, that the dashboard-summary API accepts.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DashboardSummaryListRequestQueryParameters", 
  "module_id": "PolicyIDSMetrics", 
  "properties": {
    "context": {
      "$ref": "TenancyContextQueryParameter
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Query parameters passed to the dashboard-summary API", 
  "type": "object"
}

DataCounter (type)

{
  "id": "DataCounter", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "dropped": {
      "required": false, 
      "title": "The dropped packets or bytes", 
      "type": "integer"
    }, 
    "multicast_broadcast": {
      "required": false, 
      "title": "The multicast and broadcast packets or bytes", 
      "type": "integer"
    }, 
    "total": {
      "required": true, 
      "title": "The total packets or bytes", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DataSourceParameters (type)

{
  "id": "DataSourceParameters", 
  "module_id": "Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

DataSourceType (type)

{
  "enum": [
    "realtime", 
    "cached"
  ], 
  "id": "DataSourceType", 
  "module_id": "Types", 
  "title": "Data source type.", 
  "type": "string"
}

DataTypeCollectionConfiguration (type)

{
  "id": "DataTypeCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "collection_frequency": {
      "description": "The frequency in seconds at which data is collected", 
      "maximum": 86400, 
      "minimum": 15, 
      "required": true, 
      "title": "Data Collection Frequency In Seconds", 
      "type": "integer"
    }, 
    "data_type": {
      "description": "Defines the type of data being collected", 
      "enum": [
        "STATUS", 
        "STATISTICS"
      ], 
      "required": true, 
      "title": "Data type", 
      "type": "string"
    }
  }, 
  "title": "Data type collection configuration", 
  "type": "object"
}

DatapathCounterResult (type)

{
  "description": "The datapath counter result.", 
  "id": "DatapathCounterResult", 
  "module_id": "LiveTrace", 
  "properties": {
    "module_counters": {
      "description": "The data of the datapath module counters.", 
      "items": {
        "$ref": "DatapathModuleCounter
      }, 
      "readonly": true, 
      "required": true, 
      "title": "The counters of the datapath module", 
      "type": "array"
    }, 
    "module_name": {
      "description": "The name of the datapath module (e.g., VDL2, VDR).", 
      "readonly": true, 
      "required": true, 
      "title": "The name of the datapath module", 
      "type": "string"
    }
  }, 
  "title": "Datapath counter result", 
  "type": "object"
}

DatapathModuleCounter (type)

{
  "description": "The counter of the datapath module.", 
  "id": "DatapathModuleCounter", 
  "module_id": "LiveTrace", 
  "properties": {
    "counter_name": {
      "description": "The name of the counter.", 
      "readonly": true, 
      "required": true, 
      "title": "The name of the counter", 
      "type": "string"
    }, 
    "counter_value": {
      "description": "The value of the counter.", 
      "readonly": true, 
      "required": true, 
      "title": "The value of the counter", 
      "type": "integer"
    }
  }, 
  "title": "The counter of the datapath module", 
  "type": "object"
}

DatapathStatsActionArgument (type)

{
  "id": "DatapathStatsActionArgument", 
  "module_id": "LiveTrace", 
  "properties": {
    "datapath_stats_type": {
      "description": "Type of datapath statistics action. UNI_DIRECTIONAL   - Perform the datapath statistics action for the traffic ingressed from the source logical port. BI_DIRECTIONAL   - Perform the datapath statistics action for the traffic ingressed from the source logical port and the destination logical port, respectively.", 
      "enum": [
        "UNI_DIRECTIONAL", 
        "BI_DIRECTIONAL"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of datapath statistics action", 
      "type": "string"
    }, 
    "dest_lport": {
      "description": "It is required only when the type of datapath statistics action is bidirectional.", 
      "readonly": true, 
      "required": false, 
      "title": "Destination logical port for bidirectional datapath statistics action", 
      "type": "string"
    }, 
    "reverse_filter": {
      "$ref": "LiveTraceFilterData, 
      "description": "It takes effect only when the type of datapath statistics action is bidirectional.", 
      "readonly": true, 
      "required": false, 
      "title": "Packet filter for flows of interest in reverse direction"
    }
  }, 
  "type": "object"
}

DatapathStatsActionConfig (type)

{
  "id": "DatapathStatsActionConfig", 
  "module_id": "LiveTrace", 
  "properties": {
    "action_argument": {
      "$ref": "DatapathStatsActionArgument, 
      "description": "Action argument for datapath statistics.", 
      "readonly": true, 
      "required": true, 
      "title": "Action argument for datapath statistics"
    }, 
    "sampling_argument": {
      "$ref": "SamplingArgument, 
      "description": "Only first-N sampling is supported and the maximum sampling number is 65535.", 
      "readonly": true, 
      "required": false, 
      "title": "Sample argument for datapath statistics"
    }
  }, 
  "type": "object"
}

DatapathStatsResult (type)

{
  "description": "The datapath statistics action result.", 
  "id": "DatapathStatsResult", 
  "module_id": "LiveTrace", 
  "properties": {
    "direction": {
      "enum": [
        "FORWARD", 
        "REVERSE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Direction of datapath statistics action result", 
      "type": "string"
    }, 
    "transport_node_datapath_stats": {
      "description": "The datapath statistics for transport nodes.", 
      "items": {
        "$ref": "TransportNodeDatapathStats
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Datapath statistics for transport nodes", 
      "type": "array"
    }
  }, 
  "title": "Datapath statistics action result", 
  "type": "object"
}

Datasource (type)

{
  "additionalProperties": false, 
  "description": "An instance of a datasource configuration.", 
  "id": "Datasource", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "display_name": {
      "description": "Name of a datasource instance.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Datasource instance's display name", 
      "type": "string"
    }, 
    "keystore_info": {
      "$ref": "KeyStoreInfo, 
      "description": "Key Store information for all the url aliases defined in datasource. Use this property if key store information is same for each url aliases in the datasource.", 
      "title": "Key Store Info"
    }, 
    "urls": {
      "description": "Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.", 
      "items": {
        "$ref": "UrlAlias
      }, 
      "required": true, 
      "title": "Array of relative urls and their aliases", 
      "type": "array"
    }
  }, 
  "title": "Datasource Instance", 
  "type": "object"
}

DatetimeUTC (type)

{
  "description": "Datetime string in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'", 
  "id": "DatetimeUTC", 
  "title": "Datetime string in UTC", 
  "type": "string"
}

DecryptionFailAction (type)

{
  "additionalProperties": false, 
  "description": "Action to take when TLS handshake fails.", 
  "enum": [
    "BLOCK", 
    "BYPASS"
  ], 
  "help_summary": "Use of 'BLOCK' will terminate subsequent connections.\nUse of 'BYPASS' will remember handshake failure and not intercept subsequent.\nconnections.\n", 
  "id": "DecryptionFailAction", 
  "module_id": "PolicyTlsActionProfile", 
  "readonly": true, 
  "required": false, 
  "title": "TLS handshake fail action", 
  "type": "string"
}

DefaultFilterValue (type)

{
  "additionalProperties": false, 
  "description": "An instance of a datasource configuration.", 
  "id": "DefaultFilterValue", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "description": "Filter alias.", 
      "required": true, 
      "title": "Filter alias", 
      "type": "string"
    }, 
    "value": {
      "description": "Filter default value.", 
      "required": true, 
      "title": "Filter default value", 
      "type": "string"
    }
  }, 
  "title": "Default filter values", 
  "type": "object"
}

DeleteMigrationDataFileSpec (type)

{
  "additionalProperties": false, 
  "id": "DeleteMigrationDataFileSpec", 
  "module_id": "Migration", 
  "properties": {
    "federation_site_id": {
      "description": "Id of the site in NSX-T Federation", 
      "readonly": false, 
      "required": false, 
      "title": "Id of the site in NSX-T Federation", 
      "type": "string"
    }, 
    "file_type": {
      "enum": [
        "VRA_INPUT", 
        "EDGE_CUTOVER_MAPPING", 
        "BYOT_L3_MAPPING", 
        "AVI_LB_MAPPING"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Type of the Migration data file that needs to be deleted.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DeleteRequestParameters (type)

{
  "additionalProperties": {}, 
  "id": "DeleteRequestParameters", 
  "module_id": "Common", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Parameters that affect how delete operations are processed", 
  "type": "object"
}

DependentServices (type)

{
  "additionalProperties": false, 
  "id": "DependentServices", 
  "module_id": "PolicyFirewallConfiguration", 
  "properties": {
    "dependent_services": {
      "description": "List of firewall dependent services.", 
      "items": {
        "type": "string"
      }, 
      "title": "List of firewall dependent services", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DeploymentChecksAction (type)

{
  "additionalProperties": false, 
  "description": "Pre/Post deployment checks.", 
  "id": "DeploymentChecksAction", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "action": {
      "description": "Run pre/post deployment checks. PRE_CHECKS - Run pre-check before deployment. POST_CHECKS - Run post-check after deployment. ABORT_CHECKS - Abort running pre/post deployement checks.", 
      "enum": [
        "PRE_CHECKS", 
        "POST_CHECKS", 
        "ABORT_CHECKS"
      ], 
      "required": true, 
      "title": "Pre/post deployment checks", 
      "type": "string"
    }
  }, 
  "title": "Deployment checks", 
  "type": "object"
}

DeploymentChecksStatus (type)

{
  "additionalProperties": false, 
  "description": "Pre/Post deployment status.", 
  "id": "DeploymentChecksStatus", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "description": {
      "description": "Show more information about pre/post check performed.", 
      "title": "More detail about check", 
      "type": "string"
    }, 
    "name": {
      "title": "Name of pre/post check", 
      "type": "string"
    }, 
    "reason": {
      "description": "Reason for failure of pre/post check. Otherwise empty.", 
      "title": "Reason in case of pre/post check failure", 
      "type": "string"
    }, 
    "status": {
      "description": "Status pre/post check. SUCCESS - Successfully completed pre/post check. FAILED - Failed pre/post check. WARNING - Warning in pre/post check. SKIPPED - Pre/post check skipped. IN_PROGRESS - Pre/post check in progress. STOPPING - Stopping pre/post check. STOPPED - Pre/post check stopped. NOT_STARTED - Pre/post check not started", 
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "WARNING", 
        "SKIPPED", 
        "IN_PROGRESS", 
        "STOPPING", 
        "STOPPED", 
        "NOT_STARTED"
      ], 
      "title": "Status of pre/post checks", 
      "type": "string"
    }
  }, 
  "title": "Pre/Post deployment status", 
  "type": "object"
}

DeploymentChecksStatusResult (type)

{
  "additionalProperties": false, 
  "description": "List of pre/post checks status.", 
  "id": "DeploymentChecksStatusResult", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "results": {
      "description": "Array of pre/post deployment checks.", 
      "items": {
        "$ref": "DeploymentChecksStatus
      }, 
      "title": "Array of pre/post deployment checks", 
      "type": "array"
    }
  }, 
  "title": "Status of pre/post checks", 
  "type": "object"
}

DeploymentConfig (type)

{
  "additionalProperties": false, 
  "id": "DeploymentConfig", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "placement_type"
  }, 
  "properties": {
    "placement_type": {
      "enum": [
        "VsphereDeploymentConfig"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

DeploymentProgressStatus (type)

{
  "additionalProperties": false, 
  "description": "Progress status of deployment.", 
  "id": "DeploymentProgressStatus", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "error_message": {
      "description": "Errors during deployment.", 
      "items": {
        "type": "string"
      }, 
      "title": "Error message", 
      "type": "array"
    }, 
    "overall_status": {
      "description": "Progress status of deployment. DEPLOYMENT_IN_PROGRESS - Deployment in progress. UNDEPLOYMENT_IN_PROGRESS - Undeployment in progress. UPGRADE_IN_PROGRESS - Upgrade in progress. UPDATE_IN_PROGRESS - Update in progress. DEPLOYMENT_QUEUED - Deployment queued. UNDEPLOYMENT_QUEUED - Undeployment queued. UPDATE_QUEUED - Update queued. DEPLOYMENT_SUCCESSFUL - Deployment successful. UNDEPLOYMENT_SUCCESSFUL - Undeployment successful. UPGRADE_SUCCESSFUL - Upgrade successful. UPDATE_SUCCESSFUL - Update successful. DEPLOYMENT_FAILED - Deployment failed. UNDEPLOYMENT_FAILED - Undeployment failed. UPGRADE_FAILED - Upgrade failed. UPDATE_FAILED - Update failed. NOT_DEPLOYED - Deployment pending.", 
      "enum": [
        "DEPLOYMENT_IN_PROGRESS", 
        "UNDEPLOYMENT_IN_PROGRESS", 
        "UPGRADE_IN_PROGRESS", 
        "UPDATE_IN_PROGRESS", 
        "DEPLOYMENT_QUEUED", 
        "UNDEPLOYMENT_QUEUED", 
        "UPDATE_QUEUED", 
        "DEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UPGRADE_SUCCESSFUL", 
        "UPDATE_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNDEPLOYMENT_FAILED", 
        "UPGRADE_FAILED", 
        "UPDATE_FAILED", 
        "NOT_DEPLOYED"
      ], 
      "required": true, 
      "title": "Progress status of deployment", 
      "type": "string"
    }, 
    "percentage": {
      "description": "Percentage completed for deployment.", 
      "title": "Percentage completed", 
      "type": "integer"
    }, 
    "progress_message": {
      "description": "More information about progress.", 
      "title": "Progress message", 
      "type": "string"
    }
  }, 
  "title": "Progress status of deployment/undeployment/upgrade", 
  "type": "object"
}

DeploymentRegistry (type)

{
  "additionalProperties": false, 
  "description": "Template for storing docker registry and helm url.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DeploymentRegistry", 
  "module_id": "PolicyCloudNative", 
  "policy_hierarchical_children": [
    "ChildDeploymentRegistry"
  ], 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "docker_registry": {
      "description": "Docker registry url to access docker images.", 
      "required": true, 
      "title": "Docker registry url", 
      "type": "string"
    }, 
    "helm_repo": {
      "description": "Helm repo url to access helm charts.", 
      "required": true, 
      "title": "Helm repo url", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "NSX Application Platform registry template", 
  "type": "object"
}

DeploymentSpecName (type)

{
  "description": "Used to provide the deployment spec for Upgrade.", 
  "id": "DeploymentSpecName", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "deployment_spec_name": {
      "description": "This indicates the deployment spec.", 
      "readonly": true, 
      "required": true, 
      "title": "Deployment Spec Name", 
      "type": "string"
    }, 
    "storage_id": {
      "description": "Moref of the datastore in VC.", 
      "readonly": true, 
      "required": false, 
      "title": "Storage Id", 
      "type": "string"
    }
  }, 
  "title": "Deployment spec to be used in upgrade", 
  "type": "object"
}

DeploymentTemplate (type)

{
  "description": "Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.", 
  "id": "DeploymentTemplate", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "attributes": {
      "description": "List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance and is opaque to the NSX Manager.", 
      "items": {
        "$ref": "Attribute
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Template attributes", 
      "type": "array"
    }, 
    "name": {
      "description": "Deployment Template name.", 
      "readonly": false, 
      "required": false, 
      "title": "name", 
      "type": "string"
    }
  }, 
  "title": "Service Deployment Template", 
  "type": "object"
}

DeploymentVersionSpec (type)

{
  "additionalProperties": false, 
  "description": "Deployment version with chart name", 
  "id": "DeploymentVersionSpec", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "chart_name": {
      "description": "Deployment chart name.", 
      "title": "Chart name", 
      "type": "string"
    }, 
    "versions": {
      "description": "List of deployment versions.", 
      "title": "Deployment versions", 
      "type": "string"
    }
  }, 
  "title": "Deployment version", 
  "type": "object"
}

DeploymentVersions (type)

{
  "additionalProperties": false, 
  "description": "Different NSX Application Platform deployment versions.", 
  "id": "DeploymentVersions", 
  "module_id": "PolicyCloudNative", 
  "properties": {
    "versions": {
      "description": "List of deployment versions.", 
      "items": {
        "$ref": "DeploymentVersionSpec
      }, 
      "title": "Deployment versions", 
      "type": "array"
    }
  }, 
  "title": "List of deployment versions", 
  "type": "object"
}

DeploymentZone (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Logical grouping of enforcement points. This is a deprecated type. DeploymentZone has been renamed to Site. Use Site.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DeploymentZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "policy_hierarchical_children": [
    "ChildEnforcementPoint"
  ], 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "enforcement_points": {
      "items": {
        "$ref": "EnforcementPoint
      }, 
      "required": false, 
      "title": "Logical grouping of enforcement points", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Deployment zone", 
  "type": "object"
}

DeploymentZoneListRequestParameters (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DeploymentZone list request parameters. This is a deprecated type. DeploymentZone has been renamed to Site. Use SiteListRequestParameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DeploymentZoneListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DeploymentZone list request parameters", 
  "type": "object"
}

DeploymentZoneListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Paged Collection of Deployment Zones. This is a deprecated type. DeploymentZone has been renamed to Site. Use SiteListResult.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DeploymentZoneListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DeploymentZone
      }, 
      "required": true, 
      "title": "Deployment Zones", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Deployment Zones", 
  "type": "object"
}

DestinationNsxApiEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Details about the destination NSX manager for the migration", 
  "id": "DestinationNsxApiEndpoint", 
  "module_id": "Migration", 
  "properties": {
    "destination_nsx_ip": {
      "description": "IP address or host name of the destination NSX manager to which the config will be migrated.", 
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": true, 
      "title": "Destination NSX IP ddress or host name", 
      "type": "string"
    }, 
    "destination_nsx_password": {
      "description": "Valid password for connecting to the destination NSX manager.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Password for destination NSX manager", 
      "type": "secure_string"
    }, 
    "destination_nsx_port": {
      "default": 443, 
      "description": "Destination NSX manager port that will be used to apply details.", 
      "readonly": false, 
      "required": false, 
      "title": "Destination NSX manager port", 
      "type": "int"
    }, 
    "destination_nsx_username": {
      "description": "Valid username for connecting to the destination NSX manager.", 
      "readonly": false, 
      "required": false, 
      "title": "Username for destination NSX manager", 
      "type": "string"
    }
  }, 
  "title": "Destination NSX manager details", 
  "type": "object"
}

DetachClusterParameters (type)

{
  "id": "DetachClusterParameters", 
  "properties": {
    "force": {
      "enum": [
        "true", 
        "false"
      ], 
      "type": "string"
    }, 
    "graceful-shutdown": {
      "default": "false", 
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "type": "string"
    }, 
    "ignore-repository-ip-check": {
      "default": "false", 
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "type": "string"
    }
  }, 
  "type": "object"
}

DeviceNameAndMacAddrOfPnic (type)

{
  "id": "DeviceNameAndMacAddrOfPnic", 
  "properties": {
    "device_name": {
      "description": "Device name of pnic", 
      "type": "string"
    }, 
    "mac_address": {
      "description": "MAC address of pnic", 
      "type": "string"
    }
  }, 
  "title": "Device name and MAC address of pnic", 
  "type": "object"
}

DfwFirewallConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "FirewallConfiguration
  }, 
  "id": "DfwFirewallConfiguration", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildIdsSettings", 
    "ChildPolicyExcludeList"
  ], 
  "polymorphic-type-descriptor": {
    "type-identifier": "DfwFirewallConfiguration"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "disable_auto_drafts": {
      "default": false, 
      "description": "To disable auto drafts, set it to true. By default, auto drafts are enabled.", 
      "title": "Auto draft disable flag", 
      "type": "boolean"
    }, 
    "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_firewall": {
      "default": true, 
      "description": "If set to true, Firewall is enabled.", 
      "title": "Firewall enable flag", 
      "type": "boolean"
    }, 
    "global_addrset_mode_enabled": {
      "default": true, 
      "description": "When this flag is set to true, global address set is enabled in Distributed Firewall.", 
      "title": "A flag to indicate if global address set is enabled in DFW", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idfw_enabled": {
      "default": false, 
      "description": "If set to true, identity firewall is enabled.", 
      "title": "Identity firewall enable flag", 
      "type": "boolean"
    }, 
    "idfw_event_log_scraper_enabled": {
      "default": false, 
      "description": "Enables event log scraping for Identity firewall.", 
      "title": "Enable event log scraping", 
      "type": "boolean"
    }, 
    "idfw_loginsight_enabled": {
      "default": false, 
      "description": "If set to true, collection of login/logout events from Loginsight server is enabled.", 
      "title": "Enable Loginsight server for Identity Firewall", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "DfwFirewallConfiguration"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DFW Firewall related configurations", 
  "type": "object"
}

DhGroup (type)

{
  "additionalProperties": false, 
  "description": "Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1048-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group. GROUP19 uses 256-bit Random Elliptic Curve (ECP) group. GROUP20 uses 384-bit Random ECP group. GROUP21 uses 521-bit Random ECP group.", 
  "enum": [
    "GROUP2", 
    "GROUP5", 
    "GROUP14", 
    "GROUP15", 
    "GROUP16", 
    "GROUP19", 
    "GROUP20", 
    "GROUP21"
  ], 
  "id": "DhGroup", 
  "module_id": "PolicyVpnIPSecVpn", 
  "title": "Diffie-Hellman groups", 
  "type": "string"
}

DhcpDeleteLeaseRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "DhcpDeleteLeaseRequestParameters", 
  "module_id": "Dhcp", 
  "properties": {
    "ip": {
      "$ref": "IPAddress, 
      "required": true
    }, 
    "mac": {
      "$ref": "MACAddress, 
      "required": true
    }
  }, 
  "type": "object"
}

DhcpDeleteLeases (type)

{
  "additionalProperties": false, 
  "id": "DhcpDeleteLeases", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "leases": {
      "items": {
        "$ref": "DhcpDeleteLeaseRequestParameters
      }, 
      "maxItems": 100, 
      "minItems": 1, 
      "required": true, 
      "title": "List of DHCP leases", 
      "type": "array"
    }
  }, 
  "title": "List of DHCP leases to be deleted", 
  "type": "object"
}

DhcpFilter (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DhcpFilter", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "properties": {
    "client_block_enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether DHCP client blocking is enabled", 
      "type": "boolean"
    }, 
    "server_block_enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether DHCP server blocking is enabled", 
      "type": "boolean"
    }, 
    "v6_client_block_enabled": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Indiactes whether DHCP v6 client blocking is enabled", 
      "type": "boolean"
    }, 
    "v6_server_block_enabled": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Indiactes whether DHCP V6 server blocking is enabled", 
      "type": "boolean"
    }
  }, 
  "title": "DHCP filtering configuration", 
  "type": "object"
}

DhcpHeader (type)

{
  "additionalProperties": false, 
  "id": "DhcpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "op_code": {
      "default": "BOOTREQUEST", 
      "description": "This is used to specify the general type of message. A client sending request to a server uses an op code of BOOTREQUEST, while a server replying uses an op code of BOOTREPLY.", 
      "enum": [
        "BOOTREQUEST", 
        "BOOTREPLY"
      ], 
      "required": false, 
      "title": "Message op code / message type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpIpPool (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP ip-pool to define dynamic ip allocation ranges.", 
  "extends": {
    "$ref": "IpAllocationBase
  }, 
  "id": "DhcpIpPool", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "allocation_ranges": {
      "description": "Ip-ranges to define dynamic ip allocation ranges.", 
      "items": {
        "$ref": "IpPoolRange
      }, 
      "required": true, 
      "title": "Ip-ranges", 
      "type": "array"
    }, 
    "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"
    }, 
    "error_threshold": {
      "default": 100, 
      "description": "Error threshold. Alert will be raised if the pool usage reaches the given threshold.", 
      "maximum": 100, 
      "minimum": 80, 
      "required": false, 
      "title": "Error threshold, valid [80-100], default 100", 
      "type": "integer"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress, 
      "description": "Gateway ip address of the allocation.", 
      "required": false, 
      "title": "Gateway ip"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds, [60-(2^32-1)]. Default is 86400.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "options": {
      "$ref": "DhcpOptions, 
      "description": "If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level.", 
      "required": false, 
      "title": "DHCP options"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "warning_threshold": {
      "default": 80, 
      "description": "Warning threshold. Alert will be raised if the pool usage reaches the given threshold.", 
      "maximum": 80, 
      "minimum": 50, 
      "required": false, 
      "title": "Warning threshold, valid [50-80], default 80", 
      "type": "integer"
    }
  }, 
  "title": "DHCP ip-pool", 
  "type": "object"
}

DhcpIpPoolListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A paginated list of DHCP ip pools.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpIpPoolListResult", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "A paginated list of DHCP ip pools.", 
      "items": {
        "$ref": "DhcpIpPool
      }, 
      "required": true, 
      "title": "Paginated list of DHCP ip pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "A list of DHCP ip pools", 
  "type": "object"
}

DhcpIpPoolUsage (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DhcpIpPoolUsage", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "allocated_number": {
      "required": true, 
      "title": "allocated number. COULD BE INACCURATE, REFERENCE ONLY.", 
      "type": "integer"
    }, 
    "allocated_percentage": {
      "required": true, 
      "title": "allocated percentage. COULD BE INACCURATE, REFERENCE ONLY.", 
      "type": "integer"
    }, 
    "dhcp_ip_pool_id": {
      "required": true, 
      "title": "uuid of dhcp ip pool", 
      "type": "string"
    }, 
    "pool_size": {
      "required": true, 
      "title": "pool size", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DhcpLeasePerIP (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DhcpLeasePerIP", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "expire_time": {
      "required": false, 
      "title": "expire time of the lease", 
      "type": "string"
    }, 
    "ip_address": {
      "required": true, 
      "title": "ip address of client", 
      "type": "string"
    }, 
    "lease_time": {
      "required": false, 
      "title": "lease time of the ip address, in seconds", 
      "type": "string"
    }, 
    "mac_address": {
      "required": true, 
      "title": "mac address of client", 
      "type": "string"
    }, 
    "start_time": {
      "required": true, 
      "title": "start time of lease", 
      "type": "string"
    }, 
    "subnet": {
      "required": false, 
      "title": "subnet of client network", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpLeaseRequestParameters (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "DataSourceParameters
  }, 
  "id": "DhcpLeaseRequestParameters", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "address": {
      "required": false, 
      "title": "can be an ip address, or an ip range, or a mac address", 
      "type": "string"
    }, 
    "pool_id": {
      "required": false, 
      "title": "The uuid of dhcp ip pool", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

DhcpLeases (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpLeases", 
  "module_id": "AggSvcDhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "dhcp_server_id": {
      "required": false, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "leases": {
      "items": {
        "$ref": "DhcpLeasePerIP
      }, 
      "maxItems": 65535, 
      "minItems": 0, 
      "required": false, 
      "title": "The lease info list of the server", 
      "type": "array"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "timestamp of the lease info"
    }
  }, 
  "type": "object"
}

DhcpLeasesResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpLeases
  }, 
  "id": "DhcpLeasesResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "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"
    }, 
    "connectivity_path": {
      "description": "Policy path to Segment, Tier0 or Tier1 gateway where DHCP server is attached.", 
      "required": false, 
      "title": "Policy path to Segment, Tier0 or Tier1 gateway", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "dhcp_server_id": {
      "required": false, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "leases": {
      "items": {
        "$ref": "DhcpLeasePerIP
      }, 
      "maxItems": 65535, 
      "minItems": 0, 
      "required": false, 
      "title": "The lease info list of the server", 
      "type": "array"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "timestamp of the lease info"
    }
  }, 
  "type": "object"
}

DhcpOption121 (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP option 121 to define classless static route.", 
  "id": "DhcpOption121", 
  "module_id": "Dhcp", 
  "properties": {
    "static_routes": {
      "description": "Classless static route of DHCP option 121.", 
      "items": {
        "$ref": "ClasslessStaticRoute
      }, 
      "maxItems": 27, 
      "minItems": 1, 
      "required": true, 
      "title": "DHCP classless static routes", 
      "type": "array"
    }
  }, 
  "title": "DHCP option 121", 
  "type": "object"
}

DhcpOptions (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Define DHCP options of the DHCP service.", 
  "id": "DhcpOptions", 
  "module_id": "Dhcp", 
  "properties": {
    "option121": {
      "$ref": "DhcpOption121, 
      "description": "DHCP option 121 to define classless static routes. Once Option 121 was defined, Option 249 will be auto-generated because they are equivalent.", 
      "required": false, 
      "title": "Option 121"
    }, 
    "others": {
      "customValidation": {
        "OPTION_117_NAME_SERVICE_SEARCH": {
          "allowedValues": [
            0, 
            6, 
            41, 
            44, 
            65
          ], 
          "code": 117, 
          "maxItems": 5, 
          "validator": "exact_match"
        }, 
        "OPTION_13_BOOT_FILE_SIZE": {
          "code": 13, 
          "maxItems": 1, 
          "maximum": 65535, 
          "minimum": 1, 
          "validator": "range"
        }, 
        "OPTION_150_TFTP_SERVER_ADDRESSES": {
          "code": 150, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_19_IP_FORWARDING_ENABLED": {
          "allowedValues": [
            0, 
            1
          ], 
          "code": 19, 
          "maxItems": 1, 
          "validator": "exact_match"
        }, 
        "OPTION_209_PXE_CONFIG_FILE": {
          "code": 209, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_210_PATH_PREFIX": {
          "code": 210, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_211_REBOOT_TIME": {
          "code": 211, 
          "maxItems": 1, 
          "maximum": "4294967295L", 
          "minimum": 0, 
          "validator": "range"
        }, 
        "OPTION_26_MTU": {
          "code": 26, 
          "maxItems": 1, 
          "maximum": 65535, 
          "minimum": 68, 
          "validator": "range"
        }, 
        "OPTION_28_BROADCAST_ADDRESS": {
          "code": 28, 
          "maxItems": 1, 
          "validator": "ip_address"
        }, 
        "OPTION_2_TIME_OFFSET": {
          "code": 2, 
          "maxItems": 1, 
          "maximum": 43200, 
          "minimum": -43200, 
          "validator": "range"
        }, 
        "OPTION_35_ARP_CACHE_TIMEOUT": {
          "code": 35, 
          "maxItems": 1, 
          "maximum": "4294967295L", 
          "minimum": 0, 
          "validator": "range"
        }, 
        "OPTION_40_NIS_DOMAIN_NAME": {
          "code": 40, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_41_NIS_SERVERS": {
          "code": 41, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_42_NTP_SERVERS": {
          "code": 42, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_44_NETBIOS_SERVERS": {
          "code": 44, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_45_NETBIOS_DIST_SERVERS": {
          "code": 45, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_46_NETBIOS_NODE_TYPE": {
          "allowedValues": [
            1, 
            2, 
            4, 
            8
          ], 
          "code": 46, 
          "maxItems": 4, 
          "validator": "exact_match"
        }, 
        "OPTION_47_NETBIOS_SCOPE": {
          "code": 47, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_58_RENEW_TIME": {
          "code": 58, 
          "maxItems": 1, 
          "maximum": "4294967295L", 
          "minimum": 0, 
          "validator": "range"
        }, 
        "OPTION_59_REBINDING_TIME": {
          "code": 59, 
          "maxItems": 1, 
          "maximum": "4294967295L", 
          "minimum": 0, 
          "validator": "range"
        }, 
        "OPTION_65_NIS_SERVER_ADDRESSES": {
          "code": 65, 
          "maxItems": 63, 
          "validator": "ip_address"
        }, 
        "OPTION_66_TFTFP_SERVER_NAME": {
          "code": 66, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_67_PXE_BOOT_FILE": {
          "code": 67, 
          "maxItems": 1, 
          "maximum": 255, 
          "validator": "length"
        }, 
        "OPTION_6_DNS_SERVERS": {
          "code": 6, 
          "maxItems": 2, 
          "validator": "ip_address"
        }, 
        "key": "code", 
        "keyType": "int", 
        "namespace": "GenericDhcpOptionOther"
      }, 
      "description": "To define DHCP options other than option 121 in generic format. Please note, only the following options can be defined in generic format. Those other options will be accepted without validation but will not take effect. --------------------------   Code    Name --------------------------     2   Time Offset     6   Domain Name Server     13  Boot File Size     19  Forward On/Off     26  MTU Interface     28  Broadcast Address     35  ARP Timeout     40  NIS Domain     41  NIS Servers     42  NTP Servers     44  NETBIOS Name Srv     45  NETBIOS Dist Srv     46  NETBIOS Node Type     47  NETBIOS Scope     58  Renewal Time     59  Rebinding Time     64  NIS+-Domain-Name     65  NIS+-Server-Addr     66  TFTP Server-Name (used by PXE)     67  Bootfile-Name (used by PXE)     117 Name Service Search     119 Domain Search     150 TFTP server address (used by PXE)     209 PXE Configuration File     210 PXE Path Prefix     211 PXE Reboot Time", 
      "items": {
        "$ref": "GenericDhcpOption
      }, 
      "maxItems": 255, 
      "minItems": 0, 
      "required": false, 
      "title": "Generic DHCP options other than option 121", 
      "type": "array"
    }
  }, 
  "title": "DHCP options", 
  "type": "object"
}

DhcpProfile (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP profile to specify edge cluster and members on which the dhcp server will run. A DhcpProfile can be referenced by different logical DHCP servers.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DhcpProfile", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "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"
    }, 
    "edge_cluster_id": {
      "description": "Edge cluster uuid on which the referencing logical DHCP server runs.", 
      "required": true, 
      "title": "Edge cluster uuid", 
      "type": "string"
    }, 
    "edge_cluster_member_indexes": {
      "description": "The Edge nodes on which the DHCP servers run. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If only one edge node is provided, the DHCP servers will run without HA support.", 
      "items": {
        "type": "integer"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "Edge node indexes", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "enable_standby_relocation": {
      "default": false, 
      "description": "Flag to enable the auto-relocation of standby DHCP Service in case of edge node failure. Only tier 1 and auto placed DHCP servers are considered for the relocation.", 
      "required": false, 
      "title": "Flag to enable standby DHCP server relocation", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "DHCP profile to specify edge cluster and members", 
  "type": "object"
}

DhcpProfileListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A paginated list of DHCP profiles.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpProfileListResult", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "A paginated list of logical DHCP profiles.", 
      "items": {
        "$ref": "DhcpProfile
      }, 
      "required": true, 
      "title": "Paginated list of DHCP profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "A list of DHCP profiles", 
  "type": "object"
}

DhcpRelayConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP relay configuration. Please note, the realized-state of this entity returned by the \"GET /policy/api/v1/infra/realized-state/realized-entity\" with this entity policy-path is irrelevant with the application status of this entity. Please do not rely on this returned realized-state to determine how this dhcp-relay-config was applied. The dhcp realization information was reflected in the realization states of the referencing Segment or T0/T1 gateway.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpRelayConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server_addresses": {
      "description": "DHCP server IP addresses for DHCP relay configuration. Both IPv4 and IPv6 addresses are supported.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 8, 
      "required": true, 
      "title": "DHCP relay addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DHCP relay configuration", 
  "type": "object"
}

DhcpRelayConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpRelayConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayConfig
      }, 
      "required": true, 
      "title": "DhcpRelayConfig results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DhcpRelayConfigs", 
  "type": "object"
}

DhcpRelayProfile (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DhcpRelayProfile", 
  "module_id": "DhcpRelay", 
  "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"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "required": true, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpRelayProfileListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpRelayProfileListResult", 
  "module_id": "DhcpRelay", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayProfile
      }, 
      "required": true, 
      "title": "Dhcp relay profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpRelayService (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DhcpRelayService", 
  "module_id": "DhcpRelay", 
  "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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_relay_profile_id": {
      "required": true, 
      "title": "dhcp relay profile referenced by the dhcp relay service", 
      "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpRelayServiceListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpRelayServiceListResult", 
  "module_id": "DhcpRelay", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayService
      }, 
      "required": true, 
      "title": "Dhcp relay service list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpServerConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP server configuration. Please note, the realized-state of this entity returned by the \"GET /policy/api/v1/infra/realized-state/realized-entity\" with this entity policy-path is irrelevant with the application status of this entity. Please do not rely on this returned realized-state to determine how this dhcp-server-config was applied. The dhcp realization information was reflected in the realization states of the referencing Segment or T0/T1 gateway.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpServerConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "edge_cluster_path": {
      "description": "The reference to the edge cluster using the policy path of the edge cluster. Auto assigned if only one edge cluster is configured on enforcement-point. Modifying edge cluster will reallocate DHCP server to the new edge cluster. Please note that re-allocating edge-cluster will result in losing of all exisitng DHCP lease information. Change edge cluster only when losing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.", 
      "required": false, 
      "title": "Edge cluster path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "DhcpServerConfig"
          ], 
          "relationshipType": "_UNOPTIMIZED_RELATIONSHIP_", 
          "rightType": [
            "PolicyEdgeCluster"
          ]
        }
      ]
    }, 
    "enable_standby_relocation": {
      "default": false, 
      "description": "If no \"preferred-edge-paths\" were defined, and the \"enable-standby-relocation\"=true, once a new edge-node was added to the edge-cluster, the stand-by node of the DHCP could possibly be moved to another edge-node. But there is no guarantee that the stand-by will be moved. Please note, if the dhcp-server-config was applied to a gateway, and this gateway has defined its own edge-cluster and preferred edge-nodes, then the edge-cluster and nodes defined in dhcp-server-config will be ignored.", 
      "required": false, 
      "title": "Stand-By Relocation", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "deprecated": true, 
      "description": "IP address lease time in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "IP address lease time in seconds", 
      "type": "integer"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "preferred_edge_paths": {
      "description": "Policy paths to edge nodes on which the DHCP servers run. The first edge node is assigned as active edge, and second one as stanby edge. If only one edge node is specified, the DHCP servers will run without HA support. When this property is not specified, edge nodes are auto-assigned during realization of the DHCP server.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "Edge node path", 
      "type": "array"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server_address": {
      "deprecated": true, 
      "description": "DHCP server address in CIDR format. Prefix length should be less than or equal to 30. DHCP server is deployed as DHCP relay service. This property is deprecated, use server_addresses instead. Both properties cannot be specified together with different new values.", 
      "format": "ip-cidr-block", 
      "required": false, 
      "title": "DHCP server address in CIDR format", 
      "type": "string"
    }, 
    "server_addresses": {
      "description": "DHCP server address in CIDR format. Both IPv4 and IPv6 address families are supported. Prefix length should be less than or equal to 30 for IPv4 address family and less than or equal to 126 for IPv6. When not specified, IPv4 value is auto-assigned to 100.96.0.1/30. Ignored when this object is configured at a Segment.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "DHCP server address in CIDR format", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DHCP server configuration", 
  "type": "object"
}

DhcpServerConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpServerConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpServerConfig
      }, 
      "required": true, 
      "title": "DhcpServerConfig results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DhcpServerConfigs", 
  "type": "object"
}

DhcpServerLeaseRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpServerRequestParameters
  }, 
  "id": "DhcpServerLeaseRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "address": {
      "description": "IP address, IP range or MAC address to retrieve specific lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "IP or MAC address", 
      "type": "string"
    }, 
    "connectivity_path": {
      "description": "String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.", 
      "required": true, 
      "title": "String Path of Tier0, Tier1 or Segment", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path. Required when multiple enforcement points are configured.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "segment_path": {
      "description": "Segment path to retrieve lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "Segment path to retrieve lease information", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "description": "The data source, either realtime or cached. If not provided, cached data is returned.", 
      "required": false, 
      "title": "The data source"
    }
  }, 
  "title": "DHCP server lease request parameters", 
  "type": "object"
}

DhcpServerRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DhcpServerRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "connectivity_path": {
      "description": "String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.", 
      "required": true, 
      "title": "String Path of Tier0, Tier1 or Segment", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path. Required when multiple enforcement points are configured.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DHCP server list request parameters", 
  "type": "object"
}

DhcpServerState (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DhcpServerState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpServerStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpStatistics
  }, 
  "id": "DhcpServerStatistics", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "acks": {
      "required": true, 
      "title": "The total number of DHCP ACK packets", 
      "type": "integer"
    }, 
    "declines": {
      "required": true, 
      "title": "The total number of DHCP DECLINE packets", 
      "type": "integer"
    }, 
    "dhcp_server_id": {
      "required": true, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "discovers": {
      "required": true, 
      "title": "The total number of DHCP DISCOVER packets", 
      "type": "integer"
    }, 
    "errors": {
      "required": true, 
      "title": "The total number of DHCP errors", 
      "type": "integer"
    }, 
    "informs": {
      "required": true, 
      "title": "The total number of DHCP INFORM packets", 
      "type": "integer"
    }, 
    "ip_pool_stats": {
      "items": {
        "$ref": "DhcpIpPoolUsage
      }, 
      "required": false, 
      "title": "The DHCP ip pool usage statistics", 
      "type": "array"
    }, 
    "nacks": {
      "required": true, 
      "title": "The total number of DHCP NACK packets", 
      "type": "integer"
    }, 
    "offers": {
      "required": true, 
      "title": "The total number of DHCP OFFER packets", 
      "type": "integer"
    }, 
    "releases": {
      "required": true, 
      "title": "The total number of DHCP RELEASE packets", 
      "type": "integer"
    }, 
    "requests": {
      "required": true, 
      "title": "The total number of DHCP REQUEST packets", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "timestamp of the statistics"
    }
  }, 
  "type": "object"
}

DhcpServerStatus (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DhcpServerStatus", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "active_node": {
      "required": true, 
      "title": "uuid of active transport node", 
      "type": "string"
    }, 
    "error_message": {
      "required": false, 
      "title": "Error message, if available", 
      "type": "string"
    }, 
    "service_status": {
      "description": "UP means the dhcp service is working fine on both active transport-node and stand-by transport-node (if have), hence fail-over can work at this time if there is failure happens on one of the transport-node; DOWN means the dhcp service is down on both active transport-node and stand-by node (if have), hence the dhcp-service will not repsonse any dhcp request; Error means error happens on transport-node(s) or no status is reported from transport-node(s). The dhcp service may be working (or not working); NO_STANDBY means dhcp service is working in one of the transport node while not in the other transport-node (if have). Hence if the dhcp service in the working transport-node is down, fail-over will not happen and the dhcp service will go down.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ERROR", 
        "NO_STANDBY"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "stand_by_node": {
      "required": false, 
      "title": "uuid of stand_by transport node. null if non-HA mode", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStaticBinding (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP static binding to define a static ip allocation.", 
  "extends": {
    "$ref": "IpAllocationBase
  }, 
  "id": "DhcpStaticBinding", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "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"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress, 
      "description": "Gateway ip address of the allocation.", 
      "required": false, 
      "title": "Gateway ip"
    }, 
    "host_name": {
      "description": "The host name to be assigned to the host.", 
      "format": "hostname", 
      "required": false, 
      "title": "Host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "The ip address to be assigned to the host.", 
      "required": true, 
      "title": "Ip address"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds, [60-(2^32-1)]. Default is 86400.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "The MAC address of the host.", 
      "required": true, 
      "title": "MAC address"
    }, 
    "options": {
      "$ref": "DhcpOptions, 
      "description": "If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level.", 
      "required": false, 
      "title": "DHCP options"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "DHCP static binding", 
  "type": "object"
}

DhcpStaticBindingConfig (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "DHCP IPv4 and IPv6 static bindings are extended from this abstract class.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpStaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Base class for DHCP options", 
  "type": "object"
}

DhcpStaticBindingConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpStaticBindingConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpStaticBindingConfig
      }, 
      "required": true, 
      "title": "Paginated list of DhcpStaticBindingConfig", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStaticBindingListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A paginated list of DHCP static bindings.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpStaticBindingListResult", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "A paginated list of DHCP static bindings.", 
      "items": {
        "$ref": "DhcpStaticBinding
      }, 
      "required": true, 
      "title": "Paginated list of DHCP static bindings", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "A list of DHCP static bindings", 
  "type": "object"
}

DhcpStaticBindingState (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DhcpStaticBindingState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStatistics (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DhcpStatistics", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "acks": {
      "required": true, 
      "title": "The total number of DHCP ACK packets", 
      "type": "integer"
    }, 
    "declines": {
      "required": true, 
      "title": "The total number of DHCP DECLINE packets", 
      "type": "integer"
    }, 
    "dhcp_server_id": {
      "required": true, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "discovers": {
      "required": true, 
      "title": "The total number of DHCP DISCOVER packets", 
      "type": "integer"
    }, 
    "errors": {
      "required": true, 
      "title": "The total number of DHCP errors", 
      "type": "integer"
    }, 
    "informs": {
      "required": true, 
      "title": "The total number of DHCP INFORM packets", 
      "type": "integer"
    }, 
    "ip_pool_stats": {
      "items": {
        "$ref": "DhcpIpPoolUsage
      }, 
      "required": false, 
      "title": "The DHCP ip pool usage statistics", 
      "type": "array"
    }, 
    "nacks": {
      "required": true, 
      "title": "The total number of DHCP NACK packets", 
      "type": "integer"
    }, 
    "offers": {
      "required": true, 
      "title": "The total number of DHCP OFFER packets", 
      "type": "integer"
    }, 
    "releases": {
      "required": true, 
      "title": "The total number of DHCP RELEASE packets", 
      "type": "integer"
    }, 
    "requests": {
      "required": true, 
      "title": "The total number of DHCP REQUEST packets", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "timestamp of the statistics"
    }
  }, 
  "type": "object"
}

DhcpV4Options (type)

{
  "additionalProperties": false, 
  "description": "DHCP options for IPv4 server.", 
  "id": "DhcpV4Options", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "option121": {
      "$ref": "DhcpOption121, 
      "description": "DHCP option 121 to define classless static routes.", 
      "required": false, 
      "title": "DHCP option 121"
    }, 
    "others": {
      "description": "To define DHCP options other than option 121 in generic format. Please note, only the following options can be defined in generic format. Those other options will be accepted without validation but will not take effect. --------------------------   Code    Name --------------------------     2   Time Offset     6   Domain Name Server     13  Boot File Size     19  Forward On/Off     26  MTU Interface     28  Broadcast Address     35  ARP Timeout     40  NIS Domain     41  NIS Servers     42  NTP Servers     44  NETBIOS Name Srv     45  NETBIOS Dist Srv     46  NETBIOS Node Type     47  NETBIOS Scope     58  Renewal Time     59  Rebinding Time     64  NIS+-Domain-Name     65  NIS+-Server-Addr     66  TFTP Server-Name (used by PXE)     67  Bootfile-Name (used by PXE)     117 Name Service Search     119 Domain Search     150 TFTP server address (used by PXE)     209 PXE Configuration File     210 PXE Path Prefix     211 PXE Reboot Time", 
      "items": {
        "$ref": "GenericDhcpOption
      }, 
      "maxItems": 255, 
      "minItems": 0, 
      "required": false, 
      "title": "Other DHCP options", 
      "type": "array"
    }
  }, 
  "title": "DHCP options for IPv4 address family", 
  "type": "object"
}

DhcpV4StaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP IPv4 static bindings are configured for each segment.", 
  "extends": {
    "$ref": "DhcpStaticBindingConfig
  }, 
  "id": "DhcpV4StaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DhcpV4StaticBindingConfig"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "gateway_address": {
      "$ref": "IPv4Address, 
      "description": "When not specified, gateway address is auto-assigned from segment configuration.", 
      "title": "Gateway IP address"
    }, 
    "host_name": {
      "description": "Hostname to assign to the host.", 
      "maxLength": 63, 
      "title": "Host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPv4Address, 
      "description": "IP assigned to host. The IP address must belong to the subnet, if any, configured on Segment.", 
      "required": true, 
      "title": "IP assigned to host"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "DHCP lease time in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "MAC address of the host.", 
      "required": true, 
      "title": "MAC address of host"
    }, 
    "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"
    }, 
    "options": {
      "$ref": "DhcpV4Options, 
      "description": "IPv4 DHCP options.", 
      "required": false, 
      "title": "DHCP options"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DHCP static binding", 
  "type": "object"
}

DhcpV6InfoBase (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Base type of IPv6 ip-allocation extended by ip-pool and static-binding.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DhcpV6InfoBase", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "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"
    }, 
    "dns_nameservers": {
      "description": "Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "DNS ips", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain name", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "preferred_time": {
      "description": "Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.", 
      "maximum": 4294967295, 
      "minimum": 48, 
      "required": false, 
      "title": "Preferred time", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sntp_servers": {
      "description": "SNTP server ips.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "SNTP server ips", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base type of IPv6 ip-allocation", 
  "type": "object"
}

DhcpV6IpPool (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP IPv6 ip pool to define dynamic ip allocation ranges. The DhcpV6IpPool would only provide stateless DHCP (domain search list, DNS servers, SNTP servers) to client if both the ranges and excluded_ranges are not specified.", 
  "extends": {
    "$ref": "DhcpV6InfoBase
  }, 
  "id": "DhcpV6IpPool", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "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"
    }, 
    "dns_nameservers": {
      "description": "Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "DNS ips", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain name", 
      "type": "array"
    }, 
    "excluded_ranges": {
      "description": "Excluded addresses to define dynamic ip allocation ranges.", 
      "items": {
        "$ref": "IpPoolRange
      }, 
      "maxItems": 128, 
      "minItems": 0, 
      "required": false, 
      "title": "Excluded range of IPv6 addresses", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "preferred_time": {
      "description": "Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.", 
      "maximum": 4294967295, 
      "minimum": 48, 
      "required": false, 
      "title": "Preferred time", 
      "type": "integer"
    }, 
    "ranges": {
      "description": "Ip address ranges to define dynamic ip allocation ranges.", 
      "items": {
        "$ref": "IpPoolRange
      }, 
      "maxItems": 128, 
      "minItems": 0, 
      "required": false, 
      "title": "Ip address ranges", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sntp_servers": {
      "description": "SNTP server ips.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "SNTP server ips", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "DHCP IPv6 ip pool", 
  "type": "object"
}

DhcpV6IpPoolListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A paginated list of DHCP IPv6 ip pools.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpV6IpPoolListResult", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "A paginated list of DHCP IPv6 ip pools.", 
      "items": {
        "$ref": "DhcpV6IpPool
      }, 
      "required": false, 
      "title": "Paginated list of DHCP IPv6 ip pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "A list of DHCP IPv6 ip pools", 
  "type": "object"
}

DhcpV6StaticBinding (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "DHCP IPv6 static binding to define a static ip allocation.", 
  "extends": {
    "$ref": "DhcpV6InfoBase
  }, 
  "id": "DhcpV6StaticBinding", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "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"
    }, 
    "dns_nameservers": {
      "description": "Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "DNS ips", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain name", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "When not specified, no ip address will be assigned to client host.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "Ip address list", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "The MAC address of the host. Either client-duid or mac-address, but not both.", 
      "required": false, 
      "title": "MAC address"
    }, 
    "preferred_time": {
      "description": "Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.", 
      "maximum": 4294967295, 
      "minimum": 48, 
      "required": false, 
      "title": "Preferred time", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sntp_servers": {
      "description": "SNTP server ips.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "SNTP server ips", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "DHCP IPv6 static binding", 
  "type": "object"
}

DhcpV6StaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP IPv6 static bindings are configured for each segment.", 
  "extends": {
    "$ref": "DhcpStaticBindingConfig
  }, 
  "id": "DhcpV6StaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DhcpV6StaticBindingConfig"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "dns_nameservers": {
      "description": "When not specified, no DNS nameserver will be set to client host.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "DNS nameservers to be set to client host", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "When not specified, no domain name will be assigned to client host.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain names to be assigned to client host", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "When not specified, no ip address will be assigned to client host.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "IP addresses to be assigned to client host", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "The MAC address of the client host. Either client-duid or mac-address, but not both.", 
      "required": true, 
      "title": "MAC address"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "preferred_time": {
      "description": "Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.", 
      "maximum": 4294967295, 
      "minimum": 48, 
      "required": false, 
      "title": "Preferred time", 
      "type": "integer"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sntp_servers": {
      "description": "SNTP server IP addresses.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "SNTP server ips", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "DHCP static binding", 
  "type": "object"
}

DhcpV6StaticBindingListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A paginated list of DHCP IPv6 static bindings.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpV6StaticBindingListResult", 
  "module_id": "Dhcp", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "A paginated list of DHCP IPv6 static bindings.", 
      "items": {
        "$ref": "DhcpV6StaticBinding
      }, 
      "required": false, 
      "title": "Paginated list of DHCP IPv6 static bindings", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "A list of DHCP IPv6 static bindings", 
  "type": "object"
}

Dhcpv6Header (type)

{
  "additionalProperties": false, 
  "id": "Dhcpv6Header", 
  "module_id": "Traceflow", 
  "properties": {
    "msg_type": {
      "default": "SOLICIT", 
      "description": "This is used to specify the DHCP v6 message. To request the assignment of one or more IPv6 addresses, a client first locates a DHCP server and then requests the assignment of addresses and other configuration information from the server. The client sends a Solicit message to the All_DHCP_Relay_Agents_and_Servers address to find available DHCP servers. Any server that can meet the client's requirements responds with an Advertise message. The client then chooses one of the servers and sends a Request message to the server asking for confirmed assignment of addresses and other configuration information. The server responds with a Reply message that contains the confirmed addresses and configuration. SOLICIT - A client sends a Solicit message to locate servers. ADVERTISE - A server sends and Advertise message to indicate that it is available. REQUEST - A client sends a Request message to request configuration parameters. REPLY - A server sends a Reply message containing assigned addresses and configuration parameters.", 
      "enum": [
        "SOLICIT", 
        "ADVERTISE", 
        "REQUEST", 
        "REPLY"
      ], 
      "required": false, 
      "title": "DHCP message type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectionType (type) (Deprecated)

{
  "default": "BIDIRECTIONAL", 
  "deprecated": true, 
  "enum": [
    "INGRESS", 
    "EGRESS", 
    "BIDIRECTIONAL"
  ], 
  "id": "DirectionType", 
  "module_id": "PortMirroringSwitchingProfile", 
  "title": "port mirroring direction", 
  "type": "string"
}

DirectoryAdDomain (type)

{
  "extends": {
    "$ref": "DirectoryDomain
  }, 
  "id": "DirectoryAdDomain", 
  "module_id": "DirectoryService", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DirectoryAdDomain"
  }, 
  "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"
    }, 
    "base_distinguished_name": {
      "description": "Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.", 
      "required": true, 
      "title": "Directory domain base distinguished name", 
      "type": "string"
    }, 
    "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"
    }, 
    "event_log_servers": {
      "description": "Directory domain Event Log server's information including host, name, protocol and so on.", 
      "items": {
        "$ref": "DirectoryEventLogServer
      }, 
      "maxItems": 50, 
      "readonly": true, 
      "required": false, 
      "title": "Event Log server of directory domain", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "Directory domain LDAP servers' information including host, name, port, protocol and so on.", 
      "items": {
        "$ref": "DirectoryLdapServer
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "LDAP server of directory domain", 
      "type": "array"
    }, 
    "name": {
      "description": "Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.", 
      "required": true, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "netbios_name": {
      "description": "NetBIOS names can contain all alphanumeric characters except for the certain disallowed characters. Names can contain a period, but names cannot start with a period. NetBIOS is similar to DNS in that it can serve as a directory service, but more limited as it has no provisions for a name hierarchy and names are limited to 15 characters. The netbios name is case insensitive and is stored in upper case regardless of input case.", 
      "required": true, 
      "title": "Directory domain NETBIOS name", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Domain resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdDomain is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.", 
      "enum": [
        "DirectoryAdDomain"
      ], 
      "required": true, 
      "title": "Directory domain resource type", 
      "type": "string"
    }, 
    "selective_sync_settings": {
      "$ref": "SelectiveSyncSettings, 
      "description": "SelectiveSync settings toggle the SelectiveSync feature and selected OrgUnits. If this is not specified, SelectiveSync is disabled by default.", 
      "required": false, 
      "title": "SelectiveSync settings"
    }, 
    "sync_settings": {
      "$ref": "DirectoryDomainSyncSettings, 
      "description": "Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object.", 
      "required": false, 
      "title": "Directory domain sync settings"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Active Directory Domain", 
  "type": "object"
}

DirectoryAdGroup (type)

{
  "extends": {
    "$ref": "DirectoryGroup
  }, 
  "id": "DirectoryAdGroup", 
  "module_id": "DirectoryService", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DirectoryAdGroup"
  }, 
  "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"
    }, 
    "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"
    }, 
    "distinguished_name": {
      "required": true, 
      "title": "Directory group distinguished name", 
      "type": "string"
    }, 
    "domain_id": {
      "description": "Domain ID this directory group belongs to.", 
      "required": true, 
      "title": "Domain id", 
      "type": "string"
    }, 
    "domain_name": {
      "description": "Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.", 
      "required": true, 
      "title": "Directory domain distinguished name", 
      "type": "string"
    }, 
    "domain_sync_node_id": {
      "description": "Domain sync node under which this directory group is located. We currently sync only from Root node and hence this attribute doesn't have a specific value set.", 
      "required": false, 
      "title": "Domain synchronization root node id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "object_guid": {
      "description": "GUID is a 128-bit value that is unique not only in the enterprise but also across the world. GUIDs are assigned to every object created by Active Directory, not just User and Group objects.", 
      "required": true, 
      "title": "Active directory group object guid", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.", 
      "required": true, 
      "title": "Directory group resource type for this domain", 
      "type": "string"
    }, 
    "secure_id": {
      "description": "A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components - The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID.", 
      "required": true, 
      "title": "Active directory group secure id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryDomain (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DirectoryDomain", 
  "module_id": "DirectoryService", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "event_log_servers": {
      "description": "Directory domain Event Log server's information including host, name, protocol and so on.", 
      "items": {
        "$ref": "DirectoryEventLogServer
      }, 
      "maxItems": 50, 
      "readonly": true, 
      "required": false, 
      "title": "Event Log server of directory domain", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "Directory domain LDAP servers' information including host, name, port, protocol and so on.", 
      "items": {
        "$ref": "DirectoryLdapServer
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "LDAP server of directory domain", 
      "type": "array"
    }, 
    "name": {
      "description": "Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.", 
      "required": true, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Domain resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdDomain is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.", 
      "enum": [
        "DirectoryAdDomain"
      ], 
      "required": true, 
      "title": "Directory domain resource type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Directory Domain", 
  "type": "object"
}

DirectoryDomainListResults (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DirectoryDomainListResults", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryDomain
      }, 
      "maxItems": 500, 
      "required": true, 
      "title": "List of Directory Domains", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Directory Domain", 
  "type": "object"
}

DirectoryDomainSize (type)

{
  "additionalProperties": false, 
  "id": "DirectoryDomainSize", 
  "module_id": "DirectoryService", 
  "properties": {
    "group_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of groups", 
      "type": "int"
    }, 
    "group_member_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of group members", 
      "type": "int"
    }, 
    "user_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of users", 
      "type": "int"
    }
  }, 
  "title": "Size of Directory Domain", 
  "type": "object"
}

DirectoryDomainSyncRequest (type)

{
  "id": "DirectoryDomainSyncRequest", 
  "module_id": "DirectoryService", 
  "properties": {
    "action": {
      "description": "Sync type could be either FULL sync or DELTA sync. The full sync fetches all the objects under the configured sync nodes while delta sync will get the changed objects from previous sync time.", 
      "enum": [
        "FULL_SYNC", 
        "DELTA_SYNC", 
        "STOP_SYNC"
      ], 
      "required": true, 
      "title": "Sync type requested", 
      "type": "string"
    }, 
    "delay": {
      "default": 0, 
      "description": "The delay can be added to execute the sync action in the future.", 
      "minimum": 0, 
      "required": false, 
      "title": "Request to execute the sync with some delay in seconds", 
      "type": "integer"
    }
  }, 
  "title": "Directory domain synchronization request", 
  "type": "object"
}

DirectoryDomainSyncSettings (type)

{
  "additionalProperties": false, 
  "id": "DirectoryDomainSyncSettings", 
  "module_id": "DirectoryService", 
  "properties": {
    "delta_sync_interval": {
      "default": 180, 
      "description": "Directory domain delta synchronization interval time between two delta sync in minutes.", 
      "maximum": 720, 
      "minimum": 5, 
      "required": false, 
      "title": "Delta synchronization inverval in minutes", 
      "type": "integer"
    }, 
    "full_sync_cron_expr": {
      "description": "Directory domain full synchronization schedule using cron expression. For example, cron expression \"0 0 12 ? * SUN *\" means full sync is scheduled every Sunday midnight. If this object is null, it means there is no background cron job running for full sync.", 
      "required": false, 
      "title": "Full synchronization cron expression", 
      "type": "string"
    }, 
    "sync_delay_in_sec": {
      "default": 30, 
      "description": "Sync delay after Directory domain has been successfully created. if delay is -1, initial full sync will not be triggered.", 
      "maximum": 600, 
      "minimum": -1, 
      "required": false, 
      "title": "Sync delay (in second).", 
      "type": "int"
    }
  }, 
  "title": "Domain synchronization settings", 
  "type": "object"
}

DirectoryDomainSyncStats (type)

{
  "id": "DirectoryDomainSyncStats", 
  "module_id": "DirectoryService", 
  "properties": {
    "avg_delta_sync_time": {
      "description": "All the historical delta sync are counted in calculating the average delta sync time in milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Average time spent for all historical delta sync", 
      "type": "integer"
    }, 
    "avg_full_sync_time": {
      "description": "All the historical full sync are counted in calculating the average full sync time in milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Average time spent for all historical full sync", 
      "type": "integer"
    }, 
    "current_state": {
      "description": "Current running state of the directory domain in synchronization life cycle. It could be one of the following five states. SELECTIVE_FULL_SYNC and SELECTIVE_DELTA_SYNC are sync states for selective sync.", 
      "enum": [
        "IDLE", 
        "FULL_SYNC", 
        "DELTA_SYNC", 
        "SELECTIVE_FULL_SYNC", 
        "SELECTIVE_DELTA_SYNC"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Current state of directory domain sync context", 
      "type": "string"
    }, 
    "current_state_begin_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Since what time the current state has begun. The time is expressed in millisecond epoch time.", 
      "readonly": true, 
      "required": true, 
      "title": "Current state elapsed time"
    }, 
    "num_delta_sync": {
      "description": "number of successful historical delta sync initiated either by system or by API request.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of successful delta sync", 
      "type": "integer"
    }, 
    "num_full_sync": {
      "description": "number of successful historical full sync initiated either by system or by API request.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of successful full sync", 
      "type": "integer"
    }, 
    "prev_sync_end_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "Directory domain previous sync ending time expressed in millisecond epoch time.", 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync ended time"
    }, 
    "prev_sync_error": {
      "description": "Directory domain previous sync status error if last status was failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Previous sync error", 
      "type": "string"
    }, 
    "prev_sync_status": {
      "description": "Directory domain previous sync status. It could be one of the following two states.", 
      "enum": [
        "SUCCESS", 
        "FAILURE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync status", 
      "type": "string"
    }, 
    "prev_sync_type": {
      "description": "Directory domain previous sync type. It could be one of the following five states. Right after the directory domain is configured, this field is set to IDLE.", 
      "enum": [
        "IDLE", 
        "FULL_SYNC", 
        "DELTA_SYNC", 
        "SELECTIVE_FULL_SYNC", 
        "SELECTIVE_DELTA_SYNC"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync type", 
      "type": "string"
    }
  }, 
  "title": "Directory domain synchronization statistics", 
  "type": "object"
}

DirectoryDomanDeleteRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DeleteRequestParameters
  }, 
  "id": "DirectoryDomanDeleteRequestParameters", 
  "module_id": "DirectoryService", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Directory domain delete request parameters", 
  "type": "object"
}

DirectoryEventLogServer (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DirectoryEventLogServer", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "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"
    }, 
    "domain_name": {
      "description": "Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.", 
      "required": false, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "host": {
      "description": "Directory Event Log server DNS host name or ip address which is reachable by NSX manager to be connected and do event fetching.", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Event log server host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "description": "Directory event log server connection password.", 
      "required": false, 
      "sensitive": true, 
      "title": "Event log server password", 
      "type": "secure_string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "DirectoryEventLogServerStatus, 
      "description": "Event log server connection status object", 
      "required": false, 
      "title": "Event log server connection status"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "username": {
      "description": "Directory event log server connection user name.", 
      "required": false, 
      "title": "Event log server username", 
      "type": "string"
    }
  }, 
  "title": "Event log server of directory domain", 
  "type": "object"
}

DirectoryEventLogServerStatus (type)

{
  "id": "DirectoryEventLogServerStatus", 
  "module_id": "DirectoryService", 
  "properties": {
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Additional optional detail error message", 
      "type": "string"
    }, 
    "last_event_record_id": {
      "description": "Last event record ID is an opaque integer value that shows the last successfully received event from event log server.", 
      "readonly": true, 
      "required": false, 
      "title": "Last event record ID", 
      "type": "integer"
    }, 
    "last_event_time_created": {
      "$ref": "EpochMsTimestamp, 
      "description": "Time of last successfully received and record event from event log server.", 
      "readonly": true, 
      "required": false, 
      "title": "Time when last event record ID was received"
    }, 
    "last_polling_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Last polling time"
    }, 
    "status": {
      "description": "Connection status:     OK: All OK     ERROR: Generic error", 
      "enum": [
        "OK", 
        "ERROR"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Current connection status of event log server", 
      "type": "string"
    }
  }, 
  "title": "Event log server connection status", 
  "type": "object"
}

DirectoryGroup (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DirectoryGroup", 
  "module_id": "DirectoryService", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "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"
    }, 
    "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"
    }, 
    "distinguished_name": {
      "required": true, 
      "title": "Directory group distinguished name", 
      "type": "string"
    }, 
    "domain_id": {
      "description": "Domain ID this directory group belongs to.", 
      "required": true, 
      "title": "Domain id", 
      "type": "string"
    }, 
    "domain_name": {
      "description": "Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.", 
      "required": true, 
      "title": "Directory domain distinguished name", 
      "type": "string"
    }, 
    "domain_sync_node_id": {
      "description": "Domain sync node under which this directory group is located. We currently sync only from Root node and hence this attribute doesn't have a specific value set.", 
      "required": false, 
      "title": "Domain synchronization root node id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.", 
      "required": true, 
      "title": "Directory group resource type for this domain", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryGroupListResults (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DirectoryGroupListResults", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryGroup
      }, 
      "required": true, 
      "title": "Directory group list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectoryGroupMember (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DirectoryGroupMember", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "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"
    }, 
    "group_distinguished_name": {
      "description": "Directory group distinguished name this group member belongs to.", 
      "required": true, 
      "title": "Group distinguished name", 
      "type": "string"
    }, 
    "group_id": {
      "description": "Directory group id this group member belongs to", 
      "required": true, 
      "title": "Group idnetifier", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_group_distinguished_name": {
      "description": "Directory group name this group member owns", 
      "required": true, 
      "title": "Member group distinguished name", 
      "type": "string"
    }, 
    "member_group_id": {
      "description": "Directory group id this group member owns", 
      "required": true, 
      "title": "Member group idnetifier", 
      "type": "string"
    }, 
    "nested": {
      "description": "Whether this member group is a directory member of the parent group speicified by group_id or a nested member group which parent group is also member group of the parent group speicified by group_id.", 
      "required": true, 
      "title": "Nesting flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryGroupMemberListResults (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DirectoryGroupMemberListResults", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryGroupMember
      }, 
      "required": true, 
      "title": "Directory group member list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectoryLdapServer (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DirectoryLdapServer", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "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"
    }, 
    "domain_name": {
      "description": "Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.", 
      "required": false, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "host": {
      "description": "Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization.", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "LDAP server host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "description": "Directory LDAP server connection password.", 
      "required": false, 
      "sensitive": true, 
      "title": "LDAP server password", 
      "type": "secure_string"
    }, 
    "port": {
      "default": 389, 
      "description": "Directory LDAP server connection TCP/UDP port.", 
      "max": 65535, 
      "min": 1, 
      "required": false, 
      "title": "LDAP server TCP/UDP port", 
      "type": "integer"
    }, 
    "protocol": {
      "default": "LDAP", 
      "description": "Directory LDAP server connection protocol which is either LDAP or LDAPS.", 
      "enum": [
        "LDAP", 
        "LDAPS"
      ], 
      "required": false, 
      "title": "LDAP server protocol", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "thumbprint": {
      "description": "Directory LDAP server certificate thumbprint used in secure LDAPS connection.", 
      "required": false, 
      "title": "LDAP server certificate thumbprint using SHA-256 algorithm", 
      "type": "string"
    }, 
    "username": {
      "description": "Directory LDAP server connection user name.", 
      "required": false, 
      "title": "LDAP server username", 
      "type": "string"
    }
  }, 
  "title": "LDAP server of directory domain", 
  "type": "object"
}

DirectoryLdapServerListResults (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DirectoryLdapServerListResults", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryLdapServer
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "List of directory domain LDAP servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of directory domain LDAP servers", 
  "type": "object"
}

DirectoryLdapServerStatus (type)

{
  "id": "DirectoryLdapServerStatus", 
  "module_id": "DirectoryService", 
  "properties": {
    "error_id": {
      "description": "Error ID of the directory LDAP server status maintained by the NSX directory service.", 
      "required": false, 
      "title": "Error ID of the directory LDAP server status", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Error message of the directory LDAP server status maintained by the NSX directory service.", 
      "required": false, 
      "title": "Error message of the directory LDAP server status", 
      "type": "string"
    }
  }, 
  "title": "Status LDAP server of directory domain", 
  "type": "object"
}

DirectoryLdapServerTestParameters (type)

{
  "id": "DirectoryLdapServerTestParameters", 
  "module_id": "DirectoryService", 
  "properties": {
    "action": {
      "description": "Type of LDAP server test to perform.", 
      "enum": [
        "CONNECTIVITY"
      ], 
      "required": true, 
      "title": "LDAP server test requested", 
      "type": "string"
    }
  }, 
  "title": "Parameters for performing LDAP server test", 
  "type": "object"
}

DirectoryOrgUnit (type)

{
  "id": "DirectoryOrgUnit", 
  "module_id": "DirectoryService", 
  "properties": {
    "children": {
      "description": "List of children Organization Units if any.", 
      "items": {
        "$ref": "DirectoryOrgUnit
      }, 
      "maxItems": 500, 
      "required": true, 
      "title": "List of children Organization Units", 
      "type": "array"
    }, 
    "distinguished_name": {
      "description": "Distinguished name of the organization unit.", 
      "required": true, 
      "title": "Distinguished name", 
      "type": "string"
    }, 
    "name": {
      "description": "Organization Unit name.", 
      "required": true, 
      "title": "Organization Unit name", 
      "type": "string"
    }
  }, 
  "title": "Organization Unit", 
  "type": "object"
}

DirectoryOrgUnitListResults (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DirectoryOrgUnitListResults", 
  "module_id": "DirectoryService", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryOrgUnit
      }, 
      "maxItems": 500, 
      "required": true, 
      "title": "List of Organization Units", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of organization units", 
  "type": "object"
}

DirectorySearchFilterValue (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DirectorySearchFilterValue", 
  "module_id": "DirectoryService", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "filter_value": {
      "description": "Search filter value is a substring match pattern only which the target entity contains. It is case insentive and doesn't allow wildcard.", 
      "required": true, 
      "title": "Name search filter value", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Searching domain entities using a matching filter value", 
  "type": "object"
}

DiscoveredNode (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "DiscoveredNode", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "certificate": {
      "required": false, 
      "title": "Certificate of the discovered node", 
      "type": "string"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the discovered node in the Compute Manager", 
      "type": "string"
    }, 
    "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"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the discovered node, ex. a mo-ref from VC", 
      "type": "string"
    }, 
    "hardware_id": {
      "description": "Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.", 
      "readonly": true, 
      "required": false, 
      "title": "Hardware Id of the discovered node", 
      "type": "string"
    }, 
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IP Addresses of the the discovered node.", 
      "type": "array"
    }, 
    "node_type": {
      "readonly": true, 
      "required": true, 
      "title": "Discovered Node type like Host", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this node was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of discovered\nnode in the Compute Manager\n", 
      "type": "array"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "OS type of the discovered node", 
      "type": "string"
    }, 
    "os_version": {
      "readonly": true, 
      "required": false, 
      "title": "OS version of the discovered node", 
      "type": "string"
    }, 
    "owner_nsx": {
      "description": "Specifies owner nsx of the discovered node. Owner nsx can be SELF, OTHER, MULTIPLE or NONE. SELF applies to when discovered node prepared by that nsx. OTHER applies to when discovered node prepared by other nsx. MULTIPLE applies to when discovered node tried to prepare by multiple nsx at a time. NONE applies to when discovered node is not prepared by any nsx.", 
      "enum": [
        "SELF", 
        "OTHER", 
        "MULTIPLE", 
        "NONE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Specifies owner nsx of the discovered node", 
      "type": "string"
    }, 
    "parent_compute_collection": {
      "readonly": true, 
      "required": false, 
      "title": "External id of the compute collection to which this node belongs", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "stateless": {
      "description": "The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.", 
      "readonly": true, 
      "required": false, 
      "title": "Specifies whether host is stateless", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DiscoveredNodeInterfaceProperties (type)

{
  "additionalProperties": false, 
  "description": "Network interface properties of discovered node", 
  "id": "DiscoveredNodeInterfaceProperties", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "connected_switch": {
      "description": "Switch name which is connected to nic, switch can be opaque, proxyHostSwitch or virtual", 
      "title": "Connected switch", 
      "type": "string"
    }, 
    "connected_switch_type": {
      "description": "Type of virtual switch can be VSS, DVS or N-VDS.", 
      "enum": [
        "VSS", 
        "DVS", 
        "N-VDS"
      ], 
      "required": false, 
      "title": "Type of virtual switch", 
      "type": "string"
    }, 
    "interface_id": {
      "description": "Id of the network interface", 
      "title": "Interface ID", 
      "type": "string"
    }, 
    "physical_address": {
      "$ref": "MACAddress, 
      "description": "Mac address of the interface", 
      "title": "Interface MAC address"
    }
  }, 
  "title": "Discovered node network interface properties", 
  "type": "object"
}

DiscoveredNodeListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DiscoveredNodeListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cm_local_id": {
      "required": false, 
      "title": "Local Id of the discovered node in the Compute Manager", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Display name of discovered node", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "External id of the discovered node, ex. a mo-ref from VC", 
      "type": "string"
    }, 
    "has_parent": {
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "title": "Discovered node has a parent compute collection or is a standalone host", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_address": {
      "required": false, 
      "title": "IP address of the discovered node", 
      "type": "string"
    }, 
    "node_id": {
      "required": false, 
      "title": "Id of the fabric node created from the discovered node", 
      "type": "string"
    }, 
    "node_type": {
      "required": false, 
      "title": "Discovered Node type like HostNode", 
      "type": "string"
    }, 
    "origin_id": {
      "required": false, 
      "title": "Id of the compute manager from where this node was discovered", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "parent_compute_collection": {
      "required": false, 
      "title": "External id of the compute collection to which this node belongs", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Discovered Node list parameters", 
  "type": "object"
}

DiscoveredNodeListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DiscoveredNodeListResult", 
  "module_id": "InventoryCmObj", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DiscoveredNode
      }, 
      "required": true, 
      "title": "Discovered Node list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Discovered Node list result", 
  "type": "object"
}

DiscoveredNodeNetworkInterfaces (type)

{
  "description": "All the network interfaces of the discovered node", 
  "id": "DiscoveredNodeNetworkInterfaces", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "discovered_node_id": {
      "description": "Id of the discovered node", 
      "required": true, 
      "title": "Discovered node Id", 
      "type": "string"
    }, 
    "network_interfaces": {
      "description": "Network interfaces of the node", 
      "items": {
        "$ref": "DiscoveredNodeInterfaceProperties
      }, 
      "required": false, 
      "title": "Discovered Node interfaces", 
      "type": "array"
    }
  }, 
  "title": "Discovered node network interfaces", 
  "type": "object"
}

DiscoveredResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "DiscoveredResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "mode": "force", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_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"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for resources that are discovered and automatically updated", 
  "type": "object"
}

DiscoveredResourceAssociation (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DiscoveredResourceAssociation", 
  "module_id": "InventoryAssociations", 
  "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"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_resource_type": {
      "description": "Type of the discovered resource for which association is being configured.", 
      "enum": [
        "VirtualMachine", 
        "ComputeCollection"
      ], 
      "required": true, 
      "title": "Type of the discovered 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"
    }, 
    "external_id": {
      "description": "External id of the discovered resource for which association is being configured.", 
      "required": true, 
      "title": "External id of the discovered resource", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Association for discovered resource", 
  "type": "object"
}

DiscoveredResourceAssociationListRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DiscoveredResourceAssociationListRequestParameters", 
  "module_id": "InventoryAssociations", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "discovered_resource_external_id": {
      "description": "External id of the discovered resource for which association is being queried.", 
      "required": false, 
      "title": "External id of the discovered resource", 
      "type": "string"
    }, 
    "discovered_resource_type": {
      "description": "Type of the discovered resource for which association is being queried.", 
      "enum": [
        "VirtualMachine", 
        "ComputeCollection"
      ], 
      "required": false, 
      "title": "Type of the discovered resource", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters for discovered resource associations", 
  "type": "object"
}

DiscoveredResourceScope (type)

{
  "id": "DiscoveredResourceScope", 
  "module_id": "Common", 
  "properties": {
    "scope_id": {
      "description": "Specifies the scope id of discovered resource.", 
      "required": false, 
      "title": "Scope Id of scope for discovered resource", 
      "type": "string"
    }, 
    "scope_type": {
      "description": "Type of the scope for the discovered resource.", 
      "enum": [
        "CONTAINER_CLUSTER", 
        "VPC"
      ], 
      "required": false, 
      "title": "Type of scope", 
      "type": "string"
    }
  }, 
  "title": "Scope of discovered resource", 
  "type": "object"
}

DiscoveredVifListParameters (type)

{
  "description": "The parameters to fetch the discovered VIF state.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "DiscoveredVifListParameters", 
  "module_id": "PolicyHostTransportNode", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "host_switch_id": {
      "description": "Host switch id.", 
      "required": false, 
      "title": "VDS identifier", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "segment_id": {
      "description": "Segment id.", 
      "required": false, 
      "title": "Segment identifier", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment list parameters", 
  "type": "object"
}

DiscoveredVifState (type)

{
  "description": "State of VIFs connected to discovered segment on the TransportNode.", 
  "id": "DiscoveredVifState", 
  "module_id": "PolicyHostTransportNode", 
  "properties": {
    "error_msg": {
      "description": "Error encountered during segment port creation for the discovered VIF.", 
      "required": false, 
      "title": "Error message", 
      "type": "string"
    }, 
    "id": {
      "description": "Id of discovered VIF.", 
      "required": true, 
      "title": "VIF Id", 
      "type": "string"
    }, 
    "segment_path": {
      "description": "Segment path related with discovered VIF.", 
      "required": true, 
      "title": "Path of the discovered segment", 
      "type": "string"
    }, 
    "segment_port_path": {
      "description": "SegmentPort path related with discovered VIF.", 
      "required": true, 
      "title": "Path of the segment port", 
      "type": "string"
    }, 
    "state": {
      "description": "The state of specific discovered VIF.", 
      "enum": [
        "PENDING", 
        "ATTACHMENT_IN_PROGRESS", 
        "ATTACHMENT_SUCCESS", 
        "ATTACHMENT_FAILED"
      ], 
      "title": "Discovered VIF State", 
      "type": "string"
    }
  }, 
  "title": "Discovered Vif State", 
  "type": "object"
}

DiscoveredVifStateListResult (type)

{
  "additionalProperties": false, 
  "description": "Array of result of discovered VIF state result.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DiscoveredVifStateListResult", 
  "module_id": "PolicyHostTransportNode", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DiscoveredVifState
      }, 
      "readonly": true, 
      "title": "Discovered Segment Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment queries result", 
  "type": "object"
}

DiscoveryProfileBindingMap (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Base Discovery Profile Binding Map", 
  "type": "object"
}

DiskProvisioning (type)

{
  "additionalProperties": false, 
  "description": "Disk provisioning type for deploying VM.", 
  "enum": [
    "THIN", 
    "LAZY_ZEROED_THICK", 
    "EAGER_ZEROED_THICK"
  ], 
  "id": "DiskProvisioning", 
  "module_id": "HostPrepServiceFabric", 
  "required": true, 
  "title": "Disk provisioning type", 
  "type": "string"
}

DistributedFloodProtectionProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "FloodProtectionProfile
  }, 
  "id": "DistributedFloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DistributedFloodProtectionProfile"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "enable_rst_spoofing": {
      "default": false, 
      "description": "If set to true, rst spoofing will be enabled. Flag is used only for distributed firewall profiles.", 
      "readonly": false, 
      "title": "Flag to indicate rst spoofing is enabled", 
      "type": "boolean"
    }, 
    "enable_syncache": {
      "default": false, 
      "description": "If set to true, sync cache will be enabled. Flag is used only for distributed firewall profiles.", 
      "readonly": false, 
      "title": "Flag to indicate syncache is enabled", 
      "type": "boolean"
    }, 
    "icmp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active ICMP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active ICMP connections limit", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "type": "string"
    }, 
    "other_active_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Timeout after first TN", 
      "type": "integer"
    }, 
    "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "FloodProtectionProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_half_open_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active half open TCP connections limit", 
      "type": "integer"
    }, 
    "udp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active UDP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active UDP connections limit", 
      "type": "integer"
    }, 
    "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"
    }
  }, 
  "type": "object"
}

DnsAnswer (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "The response for DNS nslookup.", 
  "id": "DnsAnswer", 
  "module_id": "DnsForwarder", 
  "properties": {
    "answers": {
      "description": "The answers of the query.", 
      "items": {
        "$ref": "DnsQueryAnswer
      }, 
      "maxItems": 256, 
      "minItems": 1, 
      "required": false, 
      "title": "The answers of the query.", 
      "type": "array"
    }, 
    "authoritative_answers": {
      "deprecated": true, 
      "description": "Authotitative answers of the query. This is a deprecated property, please use 'answers' instead.", 
      "items": {
        "$ref": "DnsQueryAnswer
      }, 
      "maxItems": 256, 
      "minItems": 1, 
      "required": false, 
      "title": "Authoritative answers", 
      "type": "array"
    }, 
    "dns_server": {
      "description": "Dns server ip address and port, format is \"ip address#port\".", 
      "required": true, 
      "title": "DNS server information", 
      "type": "string"
    }, 
    "edge_node_id": {
      "description": "ID of the edge node that performed the query.", 
      "required": true, 
      "title": "Edge node id", 
      "type": "string"
    }, 
    "non_authoritative_answers": {
      "deprecated": true, 
      "description": "Non-authotitative answers of the query. This is a deprecated property, please use 'answers' instead.", 
      "items": {
        "$ref": "DnsQueryAnswer
      }, 
      "maxItems": 256, 
      "minItems": 1, 
      "required": false, 
      "title": "Non authoritative answers", 
      "type": "array"
    }, 
    "raw_answer": {
      "description": "It can be NXDOMAIN or error message which is not consisted of authoritative_answer or non_authoritative_answer.", 
      "required": false, 
      "title": "Raw message returned from the DNS forwarder", 
      "type": "string"
    }, 
    "source_ip": {
      "$ref": "IPv4Address, 
      "description": "The source ip used in this lookup.", 
      "required": true, 
      "title": "The source ip used in this lookup"
    }
  }, 
  "title": "Answer of dns nslookup", 
  "type": "object"
}

DnsFailedQueries (type)

{
  "additionalProperties": false, 
  "description": "The array of the failed DNS queries with entry count and timestamp on active and standby transport node.", 
  "id": "DnsFailedQueries", 
  "module_id": "DnsForwarder", 
  "properties": {
    "per_node_failed_queries": {
      "description": "The array of failed DNS queries on active and standby transport node. If there is no standby node, the failed queries on standby node will not be present.", 
      "items": {
        "$ref": "PerNodeDnsFailedQueries
      }, 
      "readonly": true, 
      "required": false, 
      "title": "The array of failed DNS queries on active and standby transport node", 
      "type": "array"
    }, 
    "timestamp": {
      "description": "Timestamp of the request, in YYYY-MM-DD HH:MM:SS.zzz format.", 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp of the request", 
      "type": "string"
    }
  }, 
  "title": "The array of failed DNS queries for active and standby transport node", 
  "type": "object"
}

DnsFailedQuery (type)

{
  "description": "The summary of the failed DNS query. The query result represents a full query chain from client VM to dns forwarder, and upstream server if no forwarder cache was hit.", 
  "id": "DnsFailedQuery", 
  "module_id": "DnsForwarder", 
  "properties": {
    "address": {
      "description": "The address be queried, can be a FQDN or an ip address.", 
      "required": false, 
      "title": "The adddress be queried", 
      "type": "string"
    }, 
    "client_ip": {
      "description": "The client host ip address from which the query was issued.", 
      "required": false, 
      "title": "The client host ip address from which the query was issued", 
      "type": "string"
    }, 
    "error_message": {
      "description": "The detailed error message of the failed query, if any.", 
      "required": false, 
      "title": "The error message of the failed query", 
      "type": "string"
    }, 
    "error_type": {
      "description": "The type of the query failure, e.g. NXDOMAIN, etc.", 
      "required": false, 
      "title": "The type of the failure", 
      "type": "string"
    }, 
    "forwarder_ip": {
      "description": "The DNS forwarder ip address to which the query was first received.", 
      "required": false, 
      "title": "The DNS forwarder ip address to which the query was first received", 
      "type": "string"
    }, 
    "record_type": {
      "description": "The record type be queried, e.g. A, CNAME, SOA, etc.", 
      "required": false, 
      "title": "The record type be queried", 
      "type": "string"
    }, 
    "source_ip": {
      "description": "The source ip address that is used to forward a query to an upstream server.", 
      "required": false, 
      "title": "The source ip address for forwarding query", 
      "type": "string"
    }, 
    "time_spent": {
      "description": "The time the query took before it got a failed answer, in ms.", 
      "required": false, 
      "title": "Time spent in the query, if applicable", 
      "type": "integer"
    }, 
    "timestamp": {
      "description": "Timestamp of the request, in YYYY-MM-DD HH:MM:SS.zzz format.", 
      "required": true, 
      "title": "Timestamp of the request", 
      "type": "string"
    }, 
    "upstream_server_ip": {
      "description": "The upstream server ip address to which the query was forwarded. If the query could not be serviced from the DNS forwarder cache, this property will contain the IP address of the DNS server that serviced the request. If the request was serviced from the cache, this property will be absent.", 
      "required": false, 
      "title": "The ip address to which the query was forwarded", 
      "type": "string"
    }
  }, 
  "title": "The failed DNS query", 
  "type": "object"
}

DnsFailedQueryRequestParameters (type)

{
  "description": "To specify how many failed DNS queries will be returned.", 
  "id": "DnsFailedQueryRequestParameters", 
  "module_id": "DnsForwarder", 
  "properties": {
    "count": {
      "default": 100, 
      "description": "How many failed DNS queries should be returned.", 
      "maximum": 1000, 
      "minimum": 1, 
      "required": false, 
      "title": "The count of the failed DNS queries", 
      "type": "integer"
    }
  }, 
  "title": "The request parameters to get failed DNS queries", 
  "type": "object"
}

DnsForwarder (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "DnsForwarder", 
  "module_id": "DnsForwarder", 
  "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"
    }, 
    "cache_size": {
      "default": 1024, 
      "description": "One DNS answer cache entry will consume ~120 bytes. Hence 1 KB cache size can cache ~8 DNS answer entries, and the default 1024 KB cache size can hold ~8k DNS answer entries.", 
      "maximum": 16777216, 
      "minimum": 1, 
      "required": false, 
      "title": "Cache size in KB", 
      "type": "int"
    }, 
    "conditional_forwarders": {
      "description": "The conditional zone forwarders. During matching a zone forwarder, the DNS forwarder will use the conditional fowarder with the longest domain name that matches the query.", 
      "items": {
        "$ref": "ConditionalForwarderZone
      }, 
      "maxItems": 5, 
      "required": false, 
      "title": "Conditional zone forwarders", 
      "type": "array"
    }, 
    "default_forwarder": {
      "$ref": "ForwarderZone, 
      "description": "The default zone forwarder that catches all other domain names except those matched by conditional forwarder zone.", 
      "required": true, 
      "title": "Default zone forwarder"
    }, 
    "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"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable/disable the forwarder", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "listener_ip": {
      "$ref": "IPv4Address, 
      "description": "The ip address the DNS forwarder listens on. It can be an ip address already owned by the logical-router uplink port or router-link, or a loopback port ip address. But it can not be a downlink port address. User needs to ensure the address is reachable via router or NAT from both client VMs and upstream servers. User will need to create Firewall rules if needed to allow such traffic on a Tier-1 or Tier-0.", 
      "required": true, 
      "title": "Listener ip address"
    }, 
    "log_level": {
      "default": "INFO", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARNING", 
        "ERROR", 
        "FATAL"
      ], 
      "required": false, 
      "title": "Log level of the DNS forwarder", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "Specify the LogicalRouter where the DnsForwarder runs. The HA mode of the hosting LogicalRouter must be Active/Standby.", 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DnsForwarderListResult (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DnsForwarderListResult", 
  "module_id": "DnsForwarder", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsForwarder
      }, 
      "required": true, 
      "title": "Paginated list of DNS forwarders", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DnsForwarderStatistics (type) (Deprecated)

{
  "deprecated": true, 
  "description": "The current statistics counters of the DNS forwarder including cache usages and query numbers per forwarders.", 
  "id": "DnsForwarderStatistics", 
  "module_id": "AggSvcDnsForwarder", 
  "properties": {
    "conditional_forwarder_statistics": {
      "items": {
        "$ref": "PerForwarderStatistics
      }, 
      "maxItems": 5, 
      "minItems": 0, 
      "readonly": true, 
      "required": false, 
      "title": "The statistics of conditional forwarders", 
      "type": "array"
    }, 
    "configured_cache_size": {
      "readonly": true, 
      "title": "The configured cache size, in kb", 
      "type": "integer"
    }, 
    "default_forwarder_statistics": {
      "$ref": "PerForwarderStatistics, 
      "readonly": true, 
      "title": "The statistics of default forwarder"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message, if available", 
      "type": "string"
    }, 
    "queries_answered_locally": {
      "readonly": true, 
      "title": "The totocal number of queries answered from local cache", 
      "type": "integer"
    }, 
    "queries_forwarded": {
      "readonly": true, 
      "title": "The total number of forwarded dns queries", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Time stamp of the current statistics, in ms"
    }, 
    "total_queries": {
      "readonly": true, 
      "title": "The total number of received dns queries", 
      "type": "integer"
    }, 
    "used_cache_statistics": {
      "items": {
        "$ref": "PerNodeUsedCacheStatistics
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "readonly": true, 
      "required": false, 
      "title": "The statistics of used cache", 
      "type": "array"
    }
  }, 
  "title": "Statistics counters of the DNS forwarder", 
  "type": "object"
}

DnsForwarderStatus (type) (Deprecated)

{
  "deprecated": true, 
  "description": "The current runtime status of the DNS forwarder including the hosting transport nodes and forwarder service status.", 
  "id": "DnsForwarderStatus", 
  "module_id": "AggSvcDnsForwarder", 
  "properties": {
    "active_node": {
      "readonly": true, 
      "title": "Uuid of active transport node", 
      "type": "string"
    }, 
    "extra_message": {
      "readonly": true, 
      "required": false, 
      "title": "Extra message, if available", 
      "type": "string"
    }, 
    "standby_node": {
      "readonly": true, 
      "required": false, 
      "title": "Uuid of stand_by transport node. null if non-HA mode", 
      "type": "string"
    }, 
    "status": {
      "description": "UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The dns forwarder may be working (or not working). NO_BACKUP means dns forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ERROR", 
        "NO_BACKUP"
      ], 
      "readonly": true, 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Time stamp of the current status, in ms"
    }
  }, 
  "title": "The current runtime status of DNS forwarder", 
  "type": "object"
}

DnsHeader (type)

{
  "additionalProperties": false, 
  "id": "DnsHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "address": {
      "description": "This is used to define what is being asked or responded.", 
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "Domain name/IP to query/response", 
      "type": "string"
    }, 
    "address_type": {
      "default": "V4", 
      "description": "This is used to specify the type of the address. V4 - The address provided is an IPv4 domain name/IP address, the Type in query or response will be A V6 - The address provided is an IPv6 domain name/IP address, the Type in query or response will be AAAA", 
      "enum": [
        "V4", 
        "V6"
      ], 
      "required": false, 
      "title": null, 
      "type": "string"
    }, 
    "message_type": {
      "default": "QUERY", 
      "enum": [
        "QUERY", 
        "RESPONSE"
      ], 
      "required": false, 
      "title": "Specifies the message type whether it is a query or a response.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DnsNameString (type)

{
  "description": "DNS name string in the \"preferred name syntax\", as specified by Section 3.5 of [RFC1034] and as modified by Section 2.1 of [RFC1123].", 
  "format": "hostname", 
  "id": "DnsNameString", 
  "maxLength": 200, 
  "module_id": "CertificateManager", 
  "title": "An IA5String instance for DNS Name", 
  "type": "string"
}

DnsQueryAnswer (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "id": "DnsQueryAnswer", 
  "module_id": "DnsForwarder", 
  "properties": {
    "address": {
      "description": "Can be resolved ip address.", 
      "required": false, 
      "title": "Matched ip address", 
      "type": "string"
    }, 
    "name": {
      "description": "Matched name of the given address.", 
      "required": false, 
      "title": "Matched name", 
      "type": "string"
    }, 
    "raw_string": {
      "description": "Unparsed answer string from raw_answer.", 
      "required": false, 
      "title": "Unparsed answer string", 
      "type": "string"
    }
  }, 
  "title": "Answer of nslookup", 
  "type": "object"
}

DnsSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Used to configure DNS security profile", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DnsSecurityProfile", 
  "module_id": "PolicyProfile", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "ttl": {
      "default": 86400, 
      "description": "Time to live for DNS cache entry in seconds. Valid TTL values are between 3600 to 864000. However, this field accepts values between 0 through 864000. We define TTL type based on the value of TTL as follows: TTL 0 - cached entry never expires. TTL 1 to 3599 - invalid input and error is thrown TTL 3600 to 864000 - ttl is set to user input TTL field not set by user - TTL type is 'AUTO' and ttl value is set from DNS response packet.  User defined TTL value is used only when it is betweeen 3600 to 864000.", 
      "maximum": 864000, 
      "minimum": 0, 
      "required": false, 
      "title": "Time to live for DNS cache entry", 
      "type": "integer"
    }, 
    "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": "DNS security profile", 
  "type": "object"
}

DnsSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between DNS security profile and Group. With this entity, user can specify intent for applying DNS security profile profile to particular Group.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "DnsSecurityProfileBindingMap", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "GroupDiscoveryProfileBindingMap"
          ], 
          "relationshipType": "GROUP_BINDINGMAP_IPDISCOVERY_PROFILE_RELATIONSHIP", 
          "rightType": [
            "IPDiscoveryProfile"
          ]
        }, 
        {
          "leftType": [
            "PolicyFirewallFloodProtectionProfileBindingMap"
          ], 
          "relationshipType": "PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "FloodProtectionProfile"
          ]
        }, 
        {
          "leftType": [
            "FloodProtectionProfileBindingMap"
          ], 
          "relationshipType": "PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "FloodProtectionProfile"
          ]
        }, 
        {
          "leftType": [
            "PolicyFirewallCPUMemThresholdsProfileBindingMap"
          ], 
          "relationshipType": "PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "FirewallCPUMemoryThresholdsProfile"
          ]
        }, 
        {
          "leftType": [
            "SessionTimerProfileBindingMap"
          ], 
          "relationshipType": "PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "PolicyFirewallSessionTimerProfile"
          ]
        }, 
        {
          "leftType": [
            "DnsSecurityProfileBindingMap"
          ], 
          "relationshipType": "DNS_SECURITY_PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "DnsSecurityProfile"
          ]
        }, 
        {
          "leftType": [
            "GeneralSecurityProfileBindingMap"
          ], 
          "relationshipType": "GATEWAY_GENERAL_SECURITY_PROFILE_BINDING_MAP_PROFILE_RELATIONSHIP", 
          "rightType": [
            "GeneralSecurityProfile"
          ]
        }
      ]
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequence_number": {
      "description": "Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000.", 
      "maximum": 100000, 
      "minimum": 1, 
      "requried": true, 
      "title": "Sequence number DNS Security Profile Binding Map", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Binding Map for DNS Security Profile", 
  "type": "object"
}

DnsSecurityProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DnsSecurityProfileBindingMapListRequestParameters", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DNS Security Profile Binding Map List Request Parameters", 
  "type": "object"
}

DnsSecurityProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DnsSecurityProfileBindingMapListResult", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsSecurityProfileBindingMap
      }, 
      "requried": true, 
      "title": "DNS Security Profile Binding Map List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DNS Security Profile Binding Map", 
  "type": "object"
}

DnsSecurityProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DnsSecurityProfileListResult", 
  "module_id": "PolicyProfile", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsSecurityProfile
      }, 
      "required": true, 
      "title": "DnsSecurityProfile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of DnsSecurityProfile", 
  "type": "object"
}

DnsSettings (type)

{
  "description": "Stores Azure gateway DNS settings like dns_mode and dns_list.", 
  "id": "DnsSettings", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "dns_list": {
      "description": "The is a list of nameserver ipv4 addresses that will be used by the public cloud gateway. DNS will use these nameserver(s) if the cloud_dns_mode is set to PRECONFIGURED.", 
      "items": {
        "format": "ipv4", 
        "type": "string"
      }, 
      "required": false, 
      "title": "List of nameserver(s)", 
      "type": "array"
    }, 
    "dns_mode": {
      "default": "DHCP", 
      "description": "DHCP: Obtain nameserver(s) from DHCP. PRECONFIGURED: User supplies list of nameserver(s). CLOUD: Use cloud provider DNS.", 
      "enum": [
        "DHCP", 
        "PRECONFIGURED", 
        "CLOUD"
      ], 
      "required": false, 
      "title": "DNS mode", 
      "type": "string"
    }
  }, 
  "title": "DNS settings", 
  "type": "object"
}

DnsTtlConfig (type)

{
  "description": "Firewall to use TTL config to manage firewall cache to expire snooped FQDN entries from DNS response.", 
  "id": "DnsTtlConfig", 
  "module_id": "FirewallProfile", 
  "properties": {
    "dns_ttl_type": {
      "description": "TTL type to decide how to manage ttl.", 
      "enum": [
        "USE_TTL", 
        "AUTO", 
        "NEVER_EXPIRE"
      ], 
      "help_summary": "Use 'USE_TTL' to set custom ttl with the help of 'ttl' property.\nUse 'AUTO' to set ttl value from DNS response packet.\nUse 'NEVER_EXPIRE' to never expire cached entry.\n", 
      "required": true, 
      "title": "TTL type.", 
      "type": "string"
    }, 
    "ttl": {
      "default": 86400, 
      "description": "The number of seconds that snooped DNS responses are retained in the cache. Used only when dns_ttl_type is USE_TTL.", 
      "maximum": 864000, 
      "minimum": 3600, 
      "required": false, 
      "title": "DNS server TTL", 
      "type": "integer"
    }
  }, 
  "title": "DNS TTL config", 
  "type": "object"
}

Domain (type)

{
  "additionalProperties": false, 
  "description": "Domain.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Domain", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildCommunicationMap", 
    "ChildDomainDeploymentMap", 
    "ChildEndpointPolicy", 
    "ChildForwardingPolicy", 
    "ChildGatewayPolicy", 
    "ChildGroup", 
    "ChildIdsGatewayPolicy", 
    "ChildIdsSecurityPolicy", 
    "ChildRedirectionPolicy", 
    "ChildSecurityPolicy"
  ], 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Domain", 
  "type": "object"
}

DomainDeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Binding of domain to the enforcement point.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DomainDeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "enforcement_point_path": {
      "description": "Path of enforcement point on which domain shall be enforced.", 
      "required": true, 
      "title": "Absolute path of enforcement point", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "DomainDeploymentMap"
          ], 
          "relationshipType": "DEPLOYMENT_MAP_ENFORCEMENT_POINT_RELATIONSHIP", 
          "rightType": [
            "EnforcementPoint"
          ]
        }
      ]
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Domain Deployment Map", 
  "type": "object"
}

DomainDeploymentMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Domain Deployment Map list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DomainDeploymentMapListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Domain Deployment Map List Request Parameters", 
  "type": "object"
}

DomainDeploymentMapListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of Domain Deployment Map.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DomainDeploymentMapListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Domain Deployment Map list result.", 
      "items": {
        "$ref": "DomainDeploymentMap
      }, 
      "required": true, 
      "title": "Domain Deployment Map List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domain Deployment Map", 
  "type": "object"
}

DomainListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DomainListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Domain list request parameters", 
  "type": "object"
}

DomainListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DomainListResult", 
  "module_id": "Policy", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Domain
      }, 
      "required": true, 
      "title": "Domain list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domains", 
  "type": "object"
}

DonutConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration of a Donut", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "DonutConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DonutConfiguration"
  }, 
  "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"
    }, 
    "condition": {
      "description": "If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "count": {
      "description": "Expression to retrieve count to be shown on Donut.", 
      "title": "Expression to retrieve count to be shown on Donut", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_count": {
      "default": true, 
      "description": "If true, displays the count of entities in the donut", 
      "title": "Show or hide the count of entities", 
      "type": "boolean"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "deprecated": true, 
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "filters": {
      "description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "A List of filter ids applied to this widget configuration", 
      "type": "array"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Displayed at the middle of the donut, by default. It labels the entities of donut.", 
      "title": "Label of the Donut Configuration"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "plot_configs": {
      "description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.", 
      "items": {
        "$ref": "WidgetPlotConfiguration
      }, 
      "required": false, 
      "title": "List of plotting configuration for a given widget.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "CustomFilterWidgetConfiguration", 
        "TimeRangeDropdownFilterWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration", 
        "SpacerWidgetConfiguration", 
        "LegendWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "rowspan": {
      "description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.", 
      "minimum": 1, 
      "title": "Vertical span", 
      "type": "int"
    }, 
    "sections": {
      "decription": "High level logical grouping of portions or segments of donut.", 
      "items": {
        "$ref": "DonutSection
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Sections", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "show_header": {
      "description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.", 
      "title": "This decides to show the container header or not.", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Donut Configuration", 
  "type": "object"
}

DonutPart (type)

{
  "additionalProperties": false, 
  "description": "Represents an entity or portion to be plotted on a donut or stats chart.", 
  "id": "DonutPart", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the part will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "A numerical value that represents the portion or entity of the donut or stats chart.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Value of the portion or entity of donut or stats chart", 
      "type": "string"
    }, 
    "hide_empty_legend": {
      "default": false, 
      "description": "If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.", 
      "title": "Hide the legend if the data for the part is not available", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "If a section 'template' holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.", 
      "title": "Label of the portion or entity of donut or stats chart"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.", 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Additional rendering or conditional evaluation of the field values to be performed, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "minItems": 0, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the portion.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }
  }, 
  "title": "Portion of a donut or stats chart", 
  "type": "object"
}

DonutSection (type)

{
  "additionalProperties": false, 
  "description": "Represents high level logical grouping of portions or segments of a donut / stats chart.", 
  "id": "DonutSection", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "parts": {
      "description": "Array of portions or parts of the donut or stats chart.", 
      "items": {
        "$ref": "DonutPart
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Parts of a donut / stats chart", 
      "type": "array"
    }, 
    "row_list_field": {
      "description": "Field of the root of the api result set for forming parts.", 
      "maxLength": 1024, 
      "title": "Field from which parts of the donut or stats chart are formed", 
      "type": "string"
    }, 
    "template": {
      "default": false, 
      "description": "If true, the section will be appled as template for forming parts. Only one part will be formed from each element of 'row_list_field'.", 
      "title": "Template, if any, for automatically forming the donut or stats parts", 
      "type": "boolean"
    }
  }, 
  "title": "Section of a donut or stats chart", 
  "type": "object"
}

DpuInfo (type)

{
  "description": "Details of data processing unit (DPU) present on a ESXi Host.", 
  "id": "DpuInfo", 
  "module_id": "FabricNode", 
  "properties": {
    "dpu_id": {
      "description": "Specifies Id of DPU.", 
      "readonly": true, 
      "required": true, 
      "title": "Id of DPU", 
      "type": "string"
    }, 
    "firmware_version": {
      "description": "Specifies the firmware version of DPU.", 
      "readonly": true, 
      "required": false, 
      "title": "Firmware version of DPU", 
      "type": "string"
    }, 
    "is_primary": {
      "description": "Specifies whether this is considered the primary DPU in the host.", 
      "readonly": true, 
      "required": false, 
      "title": "Primary flag of DPU", 
      "type": "boolean"
    }, 
    "model": {
      "description": "Specifies the model of DPU.", 
      "readonly": true, 
      "required": false, 
      "title": "Model of the DPU", 
      "type": "string"
    }, 
    "os_version": {
      "description": "Specifies the operating system version of DPU.", 
      "readonly": true, 
      "required": false, 
      "title": "Operating system version of DPU", 
      "type": "string"
    }, 
    "state": {
      "description": "Specifies state of DPU.", 
      "enum": [
        "UNAVAILABLE", 
        "UNMANAGED", 
        "UNUSED", 
        "MANAGED", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of DPU", 
      "type": "string"
    }, 
    "vendor": {
      "description": "Specifies the vendor of DPU.", 
      "readonly": true, 
      "required": false, 
      "title": "Vendor of DPU", 
      "type": "string"
    }
  }, 
  "title": "DPU information for a Host Transport node", 
  "type": "object"
}

DpuStatusProperties (type)

{
  "id": "DpuStatusProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "cpu_cores": {
      "description": "The number of CPU cores on the system.", 
      "readonly": true, 
      "title": "CPU core count", 
      "type": "integer"
    }, 
    "dpu_id": {
      "readonly": true, 
      "title": "Data processing unit ID", 
      "type": "string"
    }, 
    "load_average": {
      "description": "One, five, and fifteen minute load averages for the system.", 
      "items": {
        "type": "number"
      }, 
      "readonly": true, 
      "title": "System load average", 
      "type": "array"
    }, 
    "mem_cache": {
      "description": "Amount of RAM on the system that can be flushed out to disk, in kilobytes.", 
      "readonly": true, 
      "title": "Cached RAM size in kilobytes", 
      "type": "integer"
    }, 
    "mem_total": {
      "description": "System Amount of RAM allocated to the system, in kilobytes.", 
      "readonly": true, 
      "title": "Total RAM size in kilobytes", 
      "type": "integer"
    }, 
    "mem_used": {
      "description": "Amount of RAM in use on the system, in kilobytes.", 
      "readonly": true, 
      "title": "Used RAM size in kilobytes", 
      "type": "integer"
    }
  }, 
  "title": "Data processing unit status properties", 
  "type": "object"
}

DropdownFilterPlotConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Dropdown Filter plotting configuration.", 
  "extends": {
    "$ref": "WidgetPlotConfiguration
  }, 
  "id": "DropdownFilterPlotConfiguration", 
  "module_id": "NsxDashboard", 
  "properties": {
    "allow_maximize": {
      "description": "Allow maximize capability for this widget", 
      "title": "Allow maximize capability for this widget", 
      "type": "boolean"
    }, 
    "allow_search": {
      "default": false, 
      "description": "Allow search on drop down filter.", 
      "title": "Allow search on drop down filter", 
      "type": "boolean"
    }, 
    "condition": {
      "description": "If the condition is met then the given chart config is applied to the widget configuration.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition for this chart config", 
      "type": "string"
    }
  }, 
  "title": "Dropdown Filtert plotting configuration", 
  "type": "object"
}

DropdownFilterWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for dropdown filter widget.", 
  "extends": {
    "$ref": "FilterWidgetConfiguration
  }, 
  "id": "DropdownFilterWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DropdownFilterWidgetConfiguration"
  }, 
  "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"
    }, 
    "alias": {
      "description": "Alias to be used when emitting filter value.", 
      "title": "Alias to be used when emitting filter value", 
      "type": "string"
    }, 
    "condition": {
      "description": "If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "default_value": {
      "description": "Expression to specify default value of filter.", 
      "title": "Expression to specify default value", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "dropdown_filter_plot_config": {
      "$ref": "DropdownFilterPlotConfiguration, 
      "description": "Dropdown filter plotting configuration. This plotting configuration will be applicable for the Dropdown filter only.", 
      "required": false, 
      "title": "Dropdown filter plotting configuration"
    }, 
    "dropdown_item": {
      "$ref": "DropdownItem, 
      "description": "Defines the item of a dropdown.", 
      "required": false, 
      "title": "Definition for item of a dropdown"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "deprecated": true, 
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "filters": {
      "description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "A List of filter ids applied to this widget configuration", 
      "type": "array"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "placeholder_msg": {
      "description": "Placeholder message to be displayed in dropdown filter.", 
      "title": "Placeholder message to be shown in filter", 
      "type": "string"
    }, 
    "plot_configs": {
      "description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.", 
      "items": {
        "$ref": "WidgetPlotConfiguration
      }, 
      "required": false, 
      "title": "List of plotting configuration for a given widget.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "CustomFilterWidgetConfiguration", 
        "TimeRangeDropdownFilterWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration", 
        "SpacerWidgetConfiguration", 
        "LegendWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "rowspan": {
      "description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.", 
      "minimum": 1, 
      "title": "Vertical span", 
      "type": "int"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "show_header": {
      "description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.", 
      "title": "This decides to show the container header or not.", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "static_filter_condition": {
      "description": "If the condition is met then the static filter will be added. If no condition is provided, then the static filters will be applied unconditionally.", 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "static_filters": {
      "description": "Additional static items to be added in dropdown filter. Example can be 'ALL'.", 
      "items": {
        "$ref": "StaticFilter
      }, 
      "title": "Additional static items to be added in dropdown filter", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Dropdown Filter widget Configuration", 
  "type": "object"
}

DropdownItem (type)

{
  "additionalProperties": false, 
  "id": "DropdownItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "additional_value": {
      "description": "An additional key-value pair for item to be display in dropdown.", 
      "required": false, 
      "title": "An additional value for item to be display in dropdown.", 
      "type": "object"
    }, 
    "display_name": {
      "description": "expression to extract display name to be shown in the drop down.", 
      "maxLength": 1024, 
      "title": "Display name for item to be displayed in dropdown", 
      "type": "string"
    }, 
    "field": {
      "description": "An expression that represents the items of the dropdown filter.", 
      "required": true, 
      "title": "Expression for dropdown items of filter", 
      "type": "string"
    }, 
    "short_display_name": {
      "description": "Property value is shown in the drop down input box for a filter. If the value is not provided 'display_name' property value is used.", 
      "maxLength": 1024, 
      "title": "A property value to be shown once value is selected for a filter.", 
      "type": "string"
    }, 
    "value": {
      "description": "Value of filter inside dropdown filter.", 
      "required": true, 
      "title": "Value for item to be displayed in dropdown", 
      "type": "string"
    }
  }, 
  "title": "Dropdown item definition", 
  "type": "object"
}

Dscp (type) (Deprecated)

{
  "deprecated": true, 
  "description": "Dscp value is ignored in case of 'TRUSTED' DscpMode.", 
  "id": "Dscp", 
  "module_id": "QosSwitchingProfile", 
  "properties": {
    "mode": {
      "$ref": "DscpMode
    }, 
    "priority": {
      "default": 0, 
      "maximum": 63, 
      "minimum": 0, 
      "title": "Internal Forwarding Priority", 
      "type": "int"
    }
  }, 
  "required": true, 
  "title": "One of Quality-of-Service or Encapsulated-Remote-Switched-Port-Analyzer", 
  "type": "object"
}

DscpBit (type)

{
  "additionalProperties": false, 
  "desceiption": "To define the Dscp bit in Global In-band network telemetry configuration.\n", 
  "extends": {
    "$ref": "DscpIndicator
  }, 
  "id": "DscpBit", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DSCP_BIT"
  }, 
  "properties": {
    "dscp_bit": {
      "description": "A DSCP bit is allocated to indicate the existence of INT header. It takes effect only when the INT indicator mode is DSCP_BIT. The user should guarantee that the given DSCP bit is specifically allocated for INT.", 
      "maximum": 5, 
      "minimum": 0, 
      "required": true, 
      "title": "DSCP bit for indicating the existence of INT header.", 
      "type": "int"
    }, 
    "indicator_type": {
      "enum": [
        "DSCP_BIT", 
        "DSCP_VALUE"
      ], 
      "required": true, 
      "title": "The method for indicating the existence of INT header.", 
      "type": "string"
    }
  }, 
  "title": "Dscp bit config", 
  "type": "object"
}

DscpIndicator (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "The DscpIndicator is the base class for global In-band network telemetry configurations for different types in a NSX domain.", 
  "id": "DscpIndicator", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "indicator_type"
  }, 
  "properties": {
    "indicator_type": {
      "enum": [
        "DSCP_BIT", 
        "DSCP_VALUE"
      ], 
      "required": true, 
      "title": "The method for indicating the existence of INT header.", 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for Global In-band network telemetry configuration", 
  "type": "object"
}

DscpMode (type) (Deprecated)

{
  "default": "TRUSTED", 
  "deprecated": true, 
  "enum": [
    "TRUSTED", 
    "UNTRUSTED"
  ], 
  "id": "DscpMode", 
  "module_id": "QosSwitchingProfile", 
  "title": "Trust settings", 
  "type": "string"
}

DscpTrustMode (type)

{
  "default": "TRUSTED", 
  "description": "When you select the Trusted mode the inner header DSCP value is applied to the outer IP header for IP/IPv6 traffic. For non IP/IPv6 traffic, the outer IP header takes the default value.Untrusted mode is supported on overlay-based and VLAN-based logical port.", 
  "enum": [
    "TRUSTED", 
    "UNTRUSTED"
  ], 
  "id": "DscpTrustMode", 
  "module_id": "PolicyQoS", 
  "title": "Trust settings", 
  "type": "string"
}

DscpValue (type)

{
  "additionalProperties": false, 
  "desceiption": "To define the Dscp value in Global In-band network telemetry configuration.\n", 
  "extends": {
    "$ref": "DscpIndicator
  }, 
  "id": "DscpValue", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DSCP_VALUE"
  }, 
  "properties": {
    "dscp_value": {
      "description": "A DSCP value is allocated to indicate the existence of INT header. It takes effects only when the INT indicator mode is DSCP_VALUE. The user should guarantee that the given DSCP value is specifically allocated for INT.", 
      "maximum": 63, 
      "minimum": 1, 
      "required": true, 
      "title": "DSCP value for indicating the existence of INT header.", 
      "type": "int"
    }, 
    "indicator_type": {
      "enum": [
        "DSCP_BIT", 
        "DSCP_VALUE"
      ], 
      "required": true, 
      "title": "The method for indicating the existence of INT header.", 
      "type": "string"
    }
  }, 
  "title": "Dscp bit config", 
  "type": "object"
}

DuplicateAddressBindingEntry (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "AddressBindingEntry
  }, 
  "id": "DuplicateAddressBindingEntry", 
  "module_id": "LogicalPort", 
  "properties": {
    "binding": {
      "$ref": "PacketAddressClassifier, 
      "title": "Combination of IP-MAC-VLAN binding"
    }, 
    "binding_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp at which the binding was discovered via snooping or manually specified by the user", 
      "title": "Timestamp of binding"
    }, 
    "conflicting_port": {
      "description": "Provides the ID of the port on which the same address bidning exists", 
      "required": false, 
      "title": "ID of logical port with the same address binding", 
      "type": "string"
    }, 
    "source": {
      "$ref": "AddressBindingSource, 
      "default": "UNKNOWN", 
      "description": "Source from which the address binding entry was obtained", 
      "title": "Address binding source"
    }
  }, 
  "title": "Duplicate address binding information", 
  "type": "object"
}

DuplicateIPDetection (type) (Deprecated)

{
  "deprecated": true, 
  "id": "DuplicateIPDetection", 
  "module_id": "IpDiscoverySwitchingProfile", 
  "properties": {
    "duplicate_ip_detection_enabled": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Indicates whether duplicate IP detection should be enabled", 
      "type": "boolean"
    }
  }, 
  "title": "Duplicate IP detection and control", 
  "type": "object"
}

DuplicateIPDetectionOptions (type)

{
  "additionalProperties": false, 
  "description": "Contains dupliacte IP detection related discovery options.", 
  "id": "DuplicateIPDetectionOptions", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "duplicate_ip_detection_enabled": {
      "default": false, 
      "description": "Indicates whether duplicate IP detection should be enabled", 
      "required": false, 
      "title": "Duplicate IP detection", 
      "type": "boolean"
    }
  }, 
  "title": "Controls duplicate IP detection options", 
  "type": "object"
}

DynamicContentFilterQueryParameter (type)

{
  "additionalProperties": false, 
  "id": "DynamicContentFilterQueryParameter", 
  "properties": {
    "scope": {
      "enum": [
        "NAPP"
      ], 
      "title": "Restrict scope of dynamic content filters to report", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DynamicContentFilterValue (type)

{
  "id": "DynamicContentFilterValue", 
  "title": "Support bundle dynamic content filter allowed values, for example, NAPP:SERVICE:PLATFORM_SERVICES", 
  "type": "string"
}

DynamicContentFilters (type)

{
  "additionalProperties": false, 
  "id": "DynamicContentFilters", 
  "properties": {
    "dynamic_content_filters": {
      "description": "These filter values will be set by the remote node like the NSX Intelligence Platform for instance. We would not need to know or act on these dynamic content filters, except for passing them on as request parameters along with the support bundle collection API.", 
      "items": {
        "$ref": "DynamicContentFilterValue
      }, 
      "title": "Support bundle content filter allowed values", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DynamicPluginFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "DynamicPluginFileProperties", 
  "module_id": "PolicySha", 
  "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"
    }, 
    "file_name": {
      "display": {
        "order": 2
      }, 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }, 
    "plugin_path": {
      "display": {
        "order": 1
      }, 
      "required": true, 
      "title": "Plugin id", 
      "type": "string"
    }, 
    "status": {
      "display": {
        "order": 3
      }, 
      "enum": [
        "SUCCESS", 
        "FAILURE"
      ], 
      "required": true, 
      "title": "Upload status", 
      "type": "string"
    }
  }, 
  "title": "Plugin file properties", 
  "type": "object"
}

EPActionForDnsForwarderRequestParameters (type)

{
  "id": "EPActionForDnsForwarderRequestParameters", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "action": {
      "description": "The valid DNS forwarder actions to be performed on EP are, - clear_cache:       Clear the current cache of the dns forwarder from       specified enforcement point.", 
      "enum": [
        "clear_cache"
      ], 
      "required": true, 
      "title": "An action to be performed for DNS forwarder on EP", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "default": "/infra/sites/default/enforcement-points/default", 
      "description": "An enforcement point path, on which the action is to be performed. If not specified, default enforcement point path, /infra/sites/default/enforcement-points/default will be considered.", 
      "required": false, 
      "title": "An enforcement point path, on which the action is to be performed", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EULAAcceptance (type)

{
  "additionalProperties": false, 
  "description": "Indicate the status of End User License Agreement acceptance", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "EULAAcceptance", 
  "module_id": "EULA", 
  "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"
    }, 
    "acceptance": {
      "description": "Acceptance status of End User License Agreement", 
      "required": true, 
      "title": "End User License Agreement acceptance status", 
      "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "EULA acceptance status", 
  "type": "object"
}

EULAContent (type)

{
  "additionalProperties": false, 
  "description": "End User License Agreement content", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "EULAContent", 
  "module_id": "EULA", 
  "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"
    }, 
    "content": {
      "description": "Content of End User License Agreement", 
      "required": true, 
      "sensitive": true, 
      "title": "End User License Agreement content", 
      "type": "secure_string"
    }, 
    "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"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "EULA content", 
  "type": "object"
}

EULAOutputFormatRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Indicate output format of End User License Agreement content", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "EULAOutputFormatRequestParameters", 
  "module_id": "EULA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "value_format": {
      "title": "End User License Agreement content output format", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeCluster (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "EdgeCluster", 
  "module_id": "EdgeClusters", 
  "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"
    }, 
    "allocation_rules": {
      "description": "Set of allocation rules and respected action for auto placement of logical router, DHCP and MDProxy on edge cluster members.", 
      "items": {
        "$ref": "AllocationRule
      }, 
      "required": false, 
      "title": "Allocation rules for auto placement", 
      "type": "array"
    }, 
    "cluster_profile_bindings": {
      "items": {
        "$ref": "ClusterProfileTypeIdEntry
      }, 
      "required": false, 
      "title": "Edge cluster profile bindings", 
      "type": "array"
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType, 
      "description": "This field is a readonly field which shows the deployment_type of members. It returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE| PHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE. It returns HYBRID if the cluster contains edge members of both types VIRTUAL_MACHINE and PHYSICAL_MACHINE.", 
      "readonly": true, 
      "required": false, 
      "title": "Edge cluster deployment type"
    }, 
    "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"
    }, 
    "enable_inter_site_forwarding": {
      "description": "Flag should be only use in federation for inter site l2 and l3 forwarding. Before enabling this flag, all the edge cluster members must have remote tunnel endpoint configured. TIER0/TIER1 logical routers managed by GM must be associated with edge cluster which has inter-site forwarding enabled.", 
      "readonly": true, 
      "title": "Flag to enable inter site forwarding", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_node_type": {
      "$ref": "EdgeClusterNodeType, 
      "description": "Edge cluster is homogenous collection of transport nodes. Hence all transport nodes of the cluster must be of same type. This readonly field shows the type of transport nodes.", 
      "readonly": true, 
      "required": false, 
      "title": "Node type of the cluster members"
    }, 
    "members": {
      "description": "EdgeCluster only supports homogeneous members. These member should be backed by either EdgeNode or PublicCloudGatewayNode. TransportNode type of these nodes should be the same. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.", 
      "items": {
        "$ref": "EdgeClusterMember
      }, 
      "required": false, 
      "title": "Edge cluster members", 
      "type": "array"
    }, 
    "node_rtep_ips": {
      "description": "List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.", 
      "items": {
        "$ref": "NodeRtepIpsConfig
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Remote tunnel endpoint ip address.", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeClusterAllocationStatus (type)

{
  "additionalProperties": false, 
  "description": "Allocation details of cluster and its members. Contains information of the edge nodes present in cluster, active and standby services of each node, utilization details of configured sub-pools. These allocation details can be monitored by customers to trigger migration of certain service contexts to different edge nodes, to balance the utilization of edge node resources.", 
  "id": "EdgeClusterAllocationStatus", 
  "module_id": "EdgeClusters", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "title": "Display name of the edge cluster", 
      "type": "string"
    }, 
    "id": {
      "description": "System allotted UUID of edge cluster.", 
      "readonly": true, 
      "title": "Unique identifier of edge cluster", 
      "type": "string"
    }, 
    "member_count": {
      "description": "Represents the number of edge nodes in the cluster.", 
      "readonly": true, 
      "title": "Count of edge nodes present in the cluster", 
      "type": "int"
    }, 
    "members": {
      "description": "Allocation details of edge nodes present in the cluster.", 
      "items": {
        "$ref": "EdgeMemberAllocationStatus
      }, 
      "readonly": true, 
      "title": "Allocation Status of edge nodes", 
      "type": "array"
    }
  }, 
  "title": "Allocationd details of edge cluster", 
  "type": "object"
}

EdgeClusterInterSiteStatus (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterInterSiteStatus", 
  "module_id": "AggSvcEdgeCluster", 
  "properties": {
    "edge_cluster_id": {
      "description": "Id of the edge cluster whose status is being reported.", 
      "readonly": true, 
      "required": true, 
      "title": "Edge cluster id", 
      "type": "string"
    }, 
    "edge_cluster_name": {
      "description": "Name of the edge cluster whose status is being reported.", 
      "readonly": true, 
      "title": "Edge cluster name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the edge cluster inter-site status was last updated.", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "member_status": {
      "description": "Per edge node inter-site status.", 
      "items": {
        "$ref": "EdgeClusterMemberInterSiteStatus
      }, 
      "readonly": true, 
      "title": "Per edge node inter-site status", 
      "type": "array"
    }, 
    "overall_status": {
      "description": "Overall status of all edge nodes IBGP status in the edge cluster.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN", 
        "CONFIGURED"
      ], 
      "readonly": true, 
      "title": "Overall IBGP status in the edge cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EdgeClusterListResult", 
  "module_id": "EdgeClusters", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EdgeCluster
      }, 
      "required": true, 
      "title": "Edge cluster list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterMember (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterMember", 
  "module_id": "EdgeClusters", 
  "properties": {
    "description": {
      "description": "description of edge cluster member", 
      "required": false, 
      "title": "description of edge cluster member", 
      "type": "string"
    }, 
    "display_name": {
      "description": "display name of edge cluster member", 
      "required": false, 
      "title": "display name of edge cluster member", 
      "type": "string"
    }, 
    "member_index": {
      "description": "System generated index for cluster member", 
      "readonly": true, 
      "required": false, 
      "title": "System generated index for cluster member", 
      "type": "int"
    }, 
    "transport_node_id": {
      "description": "Identifier of the transport node backed by an Edge node", 
      "required": true, 
      "title": "UUID of edge transport node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberAllocationPool (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "id": "EdgeClusterMemberAllocationPool", 
  "module_id": "LogicalRouter", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "allocation_pool_type"
  }, 
  "properties": {
    "allocation_pool_type": {
      "$ref": "AllocationPoolType, 
      "required": true
    }
  }, 
  "type": "object"
}

EdgeClusterMemberAllocationProfile (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterMemberAllocationProfile", 
  "module_id": "LogicalRouter", 
  "properties": {
    "allocation_pool": {
      "$ref": "EdgeClusterMemberAllocationPool, 
      "description": "Logical router allocation can be tracked for specific services and services may have their own hard limits and allocation sizes. For example load balancer pool should be specified if load balancer service will be attached to logical router.", 
      "required": false, 
      "title": "Edge Cluster Member Allocation Pool for logical router"
    }, 
    "allocation_type": {
      "description": "Allocation type is used to specify the mode used to allocate the LR. This is populated only for TIER1 logical router and for TIER0 this will be null.", 
      "enum": [
        "MANUAL", 
        "AUTO"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Resource allocation type", 
      "type": "string"
    }, 
    "enable_standby_relocation": {
      "default": false, 
      "description": "Flag to enable the auto-relocation of standby service router running on edge cluster and node associated with the logical router. Only dynamically allocated tier1 logical routers are considered for the relocation.", 
      "required": false, 
      "title": "Flag to enable standby service router relocation", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberIndex (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterMemberIndex", 
  "module_id": "EdgeClusters", 
  "properties": {
    "member_index": {
      "description": "Index for cluster member", 
      "required": true, 
      "title": "Index for cluster member", 
      "type": "int"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberInterSiteStatus (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterMemberInterSiteStatus", 
  "module_id": "AggSvcEdgeCluster", 
  "properties": {
    "established_bgp_sessions": {
      "description": "Total number of current established inter-site IBGP sessions.", 
      "readonly": true, 
      "title": "Established inter-site IBGP sessions", 
      "type": "integer"
    }, 
    "neighbor_status": {
      "description": "Inter-site BGP neighbor status.", 
      "items": {
        "$ref": "BgpNeighborStatusLiteDto
      }, 
      "readonly": true, 
      "title": "BGP neighbor status", 
      "type": "array"
    }, 
    "status": {
      "description": "Edge node IBGP status", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Edge node IBGP status", 
      "type": "string"
    }, 
    "total_bgp_sessions": {
      "description": "Total number of inter-site IBGP sessions.", 
      "readonly": true, 
      "title": "Total inter-site IBGP sessions", 
      "type": "integer"
    }, 
    "transport_node": {
      "$ref": "ResourceReference, 
      "description": "Edge node details from where the status is being retrived.", 
      "readonly": true, 
      "required": true, 
      "title": "Transport node"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberStatus (type)

{
  "id": "EdgeClusterMemberStatus", 
  "module_id": "AggSvcEdgeCluster", 
  "properties": {
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "ADMIN_DOWN", 
        "PARTIALLY_DISCONNECTED", 
        "UNKNOWN"
      ], 
      "required": true, 
      "title": "Status of an edge node", 
      "type": "string"
    }, 
    "transport_node": {
      "$ref": "ResourceReference, 
      "description": "Transport node backed by an Edge node.", 
      "required": true, 
      "title": "UUID of edge transport node"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberTransportNode (type)

{
  "additionalProperties": false, 
  "id": "EdgeClusterMemberTransportNode", 
  "module_id": "EdgeClusters", 
  "properties": {
    "member_index": {
      "description": "System generated index for cluster member", 
      "required": true, 
      "title": "System generated index for cluster member", 
      "type": "int"
    }, 
    "transport_node_id": {
      "description": "Identifier of the transport node backed by an Edge node", 
      "required": true, 
      "title": "UUID of edge transport node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterNodeType (type)

{
  "enum": [
    "EDGE_NODE", 
    "PUBLIC_CLOUD_GATEWAY_NODE", 
    "UNKNOWN"
  ], 
  "id": "EdgeClusterNodeType", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge cluster node type.", 
  "type": "string"
}

EdgeClusterState (type)

{
  "description": "This holds the state of Edge Cluster. If there are errors in realizing EC outside of MP, it gives details of the components and specific errors.", 
  "extends": {
    "$ref": "EdgeConfigurationState
  }, 
  "id": "EdgeClusterState", 
  "module_id": "EdgeClusters", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "pending_change_list": {
      "description": "Request identifier of the API which modified the entity.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of pending changes", 
      "type": "array"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Realization State of Edge Cluster.", 
  "type": "object"
}

EdgeClusterStatus (type)

{
  "id": "EdgeClusterStatus", 
  "module_id": "AggSvcEdgeCluster", 
  "properties": {
    "edge_cluster_id": {
      "description": "Id of the edge cluster whose status is being reported", 
      "required": true, 
      "title": "Edge cluster id", 
      "type": "string"
    }, 
    "edge_cluster_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "required": true, 
      "title": "Status of an edge node", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the cluster status was last updated", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "member_status": {
      "additionalProperties": false, 
      "items": {
        "$ref": "EdgeClusterMemberStatus
      }, 
      "readonly": true, 
      "title": "Per Edge Node Status", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeConfigDiagnosis (type)

{
  "additionalProperties": false, 
  "id": "EdgeConfigDiagnosis", 
  "properties": {
    "failed": {
      "$ref": "FailedOrWarningConfig, 
      "required": true, 
      "title": "Failed Config", 
      "type": "object"
    }, 
    "passed": {
      "items": {
        "$ref": "ConfigType
      }, 
      "required": true, 
      "title": "Passed Config", 
      "type": "array"
    }, 
    "warning": {
      "$ref": "FailedOrWarningConfig, 
      "required": true, 
      "title": "Config Warning", 
      "type": "object"
    }
  }, 
  "type": "object"
}

EdgeConfigurationState (type)

{
  "additionalProperties": false, 
  "description": "This contains fields that captures state of Trackable entities. Edge and VPN state entities extend this object.", 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "EdgeConfigurationState", 
  "module_id": "LogicalRouter", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "pending_change_list": {
      "description": "Request identifier of the API which modified the entity.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of pending changes", 
      "type": "array"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "VM_RESOURCE_RESERVATION_FAILED", 
        "DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER", 
        "DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING", 
        "EDGE_NODE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE", 
        "EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE", 
        "EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE", 
        "COMPUTE_MANAGER_NOT_FOUND", 
        "DELETE_IN_PROGRESS", 
        "ADVANCED_CONFIG_EDIT_FAILED", 
        "UPT_MODE_REALIZATION_POLL_TIMED_OUT", 
        "DATAPATH_CONFIGURATION_EDIT_FAILED", 
        "MAINTENANCE_MODE_ENABLED", 
        "ERROR_IN_ENABLE_MAINTENANCE_MODE", 
        "ERROR_IN_DISABLE_MAINTENANCE_MODE", 
        "CONFIGURE_UPT_ON_VM_FAILED", 
        "VM_VERSION_IS_UPT_INCOMPATIBLE", 
        "DELETE_FAILED_FOR_DIFFERENT_MOREF_ID", 
        "DELETE_FAILED_ON_VM_NOT_FOUND", 
        "DELETE_FAILED_FOR_NON_LCM_EDGE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Configuration State for Edge and VPN entities.", 
  "type": "object"
}

EdgeDataplaneCpuStats (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneCpuStats", 
  "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"
    }, 
    "cores": {
      "description": "Statistics of CPU cores", 
      "items": {
        "$ref": "CpuStats
      }, 
      "maxItems": 64, 
      "title": "Statistics of CPU cores", 
      "type": "array"
    }, 
    "datapath_cores_mode": {
      "description": "Mode of how the datapath cores get the packets from driver", 
      "readonly": true, 
      "title": "Datapath core mode", 
      "type": "string"
    }
  }, 
  "title": "Information about Edge Dataplane CPU Stats", 
  "type": "object"
}

EdgeDataplaneCtrlPrioSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneCtrlPrioSetting", 
  "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"
    }, 
    "ctrl_prio_enabled": {
      "description": "Control packet prioritization setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane control packet prioritization setting.", 
  "type": "object"
}

EdgeDataplaneDynamicCoreSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneDynamicCoreSetting", 
  "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"
    }, 
    "dynamic_core_enabled": {
      "description": "Edge Dataplane dynamic core setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane control dynamic core setting.", 
  "type": "object"
}

EdgeDataplaneFlow (type)

{
  "additionalProperties": false, 
  "id": "EdgeDataplaneFlow", 
  "properties": {
    "dst_ip": {
      "description": "Destination IP of the flow", 
      "title": "Destination IP", 
      "type": "string"
    }, 
    "dst_port": {
      "description": "Destination port of the flow", 
      "title": "Destination port", 
      "type": "integer"
    }, 
    "proto": {
      "description": "Protocol of the flow", 
      "title": "Protocol", 
      "type": "integer"
    }, 
    "src_ip": {
      "description": "Source IP of the flow", 
      "title": "Source IP", 
      "type": "string"
    }, 
    "src_port": {
      "description": "Source port of the flow", 
      "title": "Source port", 
      "type": "integer"
    }, 
    "tunnel_dst_ip": {
      "description": "Tunnel destination IP of the flow", 
      "title": "Tunnel destination IP", 
      "type": "string"
    }, 
    "tunnel_src_ip": {
      "description": "Tunnel source IP of the flow", 
      "title": "Tunnel source IP", 
      "type": "string"
    }
  }, 
  "title": "Edge dataplane flow record", 
  "type": "object"
}

EdgeDataplaneFlowCacheSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneFlowCacheSetting", 
  "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"
    }, 
    "flow_cache_enabled": {
      "description": "Flow cache setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane Flow Cache mode.", 
  "type": "object"
}

EdgeDataplaneFlowMonitorMessage (type)

{
  "additionalProperties": false, 
  "id": "EdgeDataplaneFlowMonitorMessage", 
  "properties": {
    "message": {
      "description": "Edge dataplane flow monitor message", 
      "title": "Message", 
      "type": "string"
    }
  }, 
  "title": "Edge dataplane flow monitor message", 
  "type": "object"
}

EdgeDataplaneFlowMonitorStartSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneFlowMonitorStartSetting", 
  "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"
    }, 
    "core_id": {
      "description": "Flow monitor core id", 
      "title": "Core id", 
      "type": "string"
    }, 
    "timeout": {
      "default": "15", 
      "description": "Flow monitor timeout in seconds", 
      "title": "Timeout for flow monitor in seconds, in the range of 1 - 600.", 
      "type": "string"
    }
  }, 
  "title": "Information about Edge Dataplane flow monitor start setting.", 
  "type": "object"
}

EdgeDataplaneFlowQueryParameters (type)

{
  "extends": {
    "$ref": "ListResultQueryParameters
  }, 
  "id": "EdgeDataplaneFlowQueryParameters", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "top_10": {
      "default": false, 
      "description": "Collect top 10 flows when set to true, else collect all flows.", 
      "title": "Collect top 10 flows when set to true", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

EdgeDataplaneFwContexts (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneFwContexts", 
  "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"
    }, 
    "results": {
      "description": "Firewall context", 
      "items": {
        "$ref": "FwContexts
      }, 
      "maxItems": 4096, 
      "title": "Firewall Context", 
      "type": "array"
    }
  }, 
  "title": "Information about Edge Dataplane firewall contexts", 
  "type": "object"
}

EdgeDataplaneGeneveCbitSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneGeneveCbitSetting", 
  "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"
    }, 
    "geneve_cbit_set": {
      "description": "geneve critical bit setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane geneve cbit setting.", 
  "type": "object"
}

EdgeDataplaneIntrModeSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneIntrModeSetting", 
  "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"
    }, 
    "intr_mode_enabled": {
      "description": "interrupt mode setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane interrupt mode setting.", 
  "type": "object"
}

EdgeDataplaneL2vpnPmtuSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneL2vpnPmtuSetting", 
  "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"
    }, 
    "l2vpn_pmtu_enabled": {
      "description": "l2vpn pmtu setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane l2vpn pmtu message generation setting.", 
  "type": "object"
}

EdgeDataplanePmtuLearningSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplanePmtuLearningSetting", 
  "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"
    }, 
    "pmtu_learning_enabled": {
      "description": "l3vpn pmtu setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane pmtu learning setting.", 
  "type": "object"
}

EdgeDataplaneQatAdminSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneQatAdminSetting", 
  "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"
    }, 
    "qat_admin_enabled": {
      "description": "QAT feature enabled setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane QAT feature enabled setting.", 
  "type": "object"
}

EdgeDataplaneQatAdminSettingResponse (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneQatAdminSettingResponse", 
  "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"
    }, 
    "update_message": {
      "description": "Message to display after setting QAT feature", 
      "readonly": true, 
      "title": "Datapath QAT enable CLI message", 
      "type": "string"
    }
  }, 
  "title": "Information about Edge Dataplane QAT feature enabled setting.", 
  "type": "object"
}

EdgeDataplaneQatStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneQatStatus", 
  "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"
    }, 
    "admin_status": {
      "description": "QAT device enabled", 
      "readonly": true, 
      "title": "QAT enabled", 
      "type": "boolean"
    }, 
    "device_present": {
      "description": "QAT device present", 
      "readonly": true, 
      "title": "QAT present", 
      "type": "boolean"
    }, 
    "fips_compliant": {
      "description": "FIPS compliance of QAT feature", 
      "readonly": true, 
      "title": "FIPS compliance", 
      "type": "boolean"
    }, 
    "is_vm": {
      "description": "Edge is deployed in VM", 
      "readonly": true, 
      "title": "VM deployment", 
      "type": "boolean"
    }, 
    "operational_status": {
      "description": "QAT device currently running", 
      "readonly": true, 
      "title": "QAT running", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane QAT status", 
  "type": "object"
}

EdgeDataplaneQueueNumPerPortPerCoreSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneQueueNumPerPortPerCoreSetting", 
  "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"
    }, 
    "queue_num_per_port_per_core": {
      "description": "queue number per port per core", 
      "maximum": 16, 
      "minimum": 1, 
      "type": "integer"
    }
  }, 
  "title": "Information about Edge Dataplane queue num per port per core setting.", 
  "type": "object"
}

EdgeDataplaneRingSize (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneRingSize", 
  "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"
    }, 
    "rx_ring_size": {
      "description": "rx ring size", 
      "type": "integer"
    }, 
    "tx_ring_size": {
      "description": "tx ring size", 
      "type": "integer"
    }
  }, 
  "title": "Information about Edge physical port ring size.", 
  "type": "object"
}

EdgeDataplaneRingSizeSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneRingSizeSetting", 
  "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"
    }, 
    "ring_size": {
      "description": "ring size", 
      "type": "integer"
    }
  }, 
  "title": "Information about Edge physical port ring size setting.", 
  "type": "object"
}

EdgeDataplaneTopKFlowQueryParameters (type)

{
  "extends": {
    "$ref": "ListResultQueryParameters
  }, 
  "id": "EdgeDataplaneTopKFlowQueryParameters", 
  "properties": {
    "core_id": {
      "description": "CPU core on which the flows are to be monitored", 
      "maximum": 128, 
      "minimum": 0, 
      "title": "CPU core on which the flows are to be monitored", 
      "type": "integer"
    }, 
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "timeout": {
      "default": 30, 
      "description": "Timeout for flow monitor in seconds", 
      "maximum": 120, 
      "minimum": 1, 
      "title": "Timeout for flow monitor in seconds", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

EdgeDataplaneTopKFlows (type)

{
  "id": "EdgeDataplaneTopKFlows", 
  "properties": {
    "flow_count": {
      "description": "Count of flow records in the result", 
      "title": "Count of flow records", 
      "type": "integer"
    }, 
    "flows": {
      "description": "Array of flow records", 
      "items": {
        "$ref": "EdgeDataplaneFlow
      }, 
      "title": "Array of flow records", 
      "type": "array"
    }
  }, 
  "title": "Edge dataplane top-k flow dump", 
  "type": "object"
}

EdgeDataplaneUptModeSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeDataplaneUptModeSetting", 
  "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"
    }, 
    "upt_mode_enabled": {
      "default": false, 
      "description": "UPT (Uniform Pass Thru) mode setting", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge Dataplane UPT mode setting.", 
  "type": "object"
}

EdgeDeploymentType (type)

{
  "enum": [
    "VIRTUAL_MACHINE", 
    "PHYSICAL_MACHINE", 
    "UNKNOWN"
  ], 
  "id": "EdgeDeploymentType", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge deployment type.", 
  "type": "string"
}

EdgeDiagnosis (type)

{
  "additionalProperties": false, 
  "id": "EdgeDiagnosis", 
  "properties": {
    "config": {
      "$ref": "EdgeConfigDiagnosis, 
      "required": true, 
      "title": "Edge Config Diagnosis", 
      "type": "object"
    }, 
    "ha-state": {
      "enum": [
        "disabled", 
        "offline", 
        "discover", 
        "statesync", 
        "inactive", 
        "active", 
        "unknown"
      ], 
      "required": true, 
      "title": "HA State", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeDiagnosisInconsistency (type)

{
  "id": "EdgeDiagnosisInconsistency", 
  "properties": {
    "detail": {
      "description": "NSX Edge inconsistency check detail", 
      "items": {
        "type": "string"
      }, 
      "title": "NSX Edge inconsistency check detail", 
      "type": "array"
    }, 
    "title": {
      "description": "NSX Edge inconsistency check type", 
      "title": "NSX Edge inconsistency check type", 
      "type": "string"
    }
  }, 
  "title": "NSX Edge inconsistency check", 
  "type": "object"
}

EdgeDiagnosisInconsistencyResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EdgeDiagnosisInconsistencyResult", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EdgeDiagnosisInconsistency
      }, 
      "title": "NSX Edge inconsistency check result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSX Edge inconsistency check result", 
  "type": "object"
}

EdgeFormFactor (type)

{
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE", 
    "XLARGE"
  ], 
  "id": "EdgeFormFactor", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge form factor.", 
  "type": "string"
}

EdgeHighAvailabilityProfile (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "ClusterProfile
  }, 
  "id": "EdgeHighAvailabilityProfile", 
  "module_id": "EdgeHighAvailabilityProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EdgeHighAvailabilityProfile"
  }, 
  "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"
    }, 
    "bfd_allowed_hops": {
      "default": 255, 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "BFD allowed hops", 
      "type": "integer"
    }, 
    "bfd_declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "bfd_probe_interval": {
      "default": 500, 
      "maximum": 60000, 
      "minimum": 50, 
      "required": false, 
      "title": "the time interval (in millisec) between probe packets for heartbeat purpose", 
      "type": "integer"
    }, 
    "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"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "standby_relocation_config": {
      "$ref": "StandbyRelocationConfig, 
      "required": false, 
      "title": "Standby service contexts relocation setting"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD HA cluster setting", 
  "type": "object"
}

EdgeIPSecDetermRSSSetting (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeIPSecDetermRSSSetting", 
  "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"
    }, 
    "deterministic_esp_rss": {
      "description": "Deterministically queue ESP packets to CPU queues, to achieve higher throughout.", 
      "type": "boolean"
    }
  }, 
  "title": "Information about Edge IPSec Deterministic RSS Setting.", 
  "type": "object"
}

EdgeIPSecDetermRSSValues (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EdgeIPSecDetermRSSValues", 
  "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"
    }, 
    "deterministic_esp_rss_driver_status": {
      "description": "Shows driver status of deterministic esp rss feature.", 
      "type": "string"
    }, 
    "deterministic_esp_rss_enabled": {
      "description": "Shows configured value of deterministic esp rss feature.", 
      "type": "boolean"
    }, 
    "deterministic_esp_rss_status": {
      "description": "Shows runtime status of deterministic esp rss feature.", 
      "type": "string"
    }
  }, 
  "title": "Information about Edge IPSec Deterministic RSS Values.", 
  "type": "object"
}

EdgeInconsistencyQueryParameters (type)

{
  "additionalProperties": false, 
  "id": "EdgeInconsistencyQueryParameters", 
  "properties": {
    "cursor": {
      "description": "A cursor points to a specific record in the inconsistency check result", 
      "minimum": 0, 
      "required": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "integer"
    }, 
    "page_size": {
      "description": "The page size determines the number of records to be returned", 
      "maximum": 100, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

EdgeMemberAllocationStatus (type)

{
  "additionalProperties": false, 
  "id": "EdgeMemberAllocationStatus", 
  "module_id": "EdgeClusters", 
  "properties": {
    "allocated_services": {
      "description": "List of services allocated on the edge node.", 
      "items": {
        "$ref": "AllocatedService
      }, 
      "readonly": true, 
      "title": "Services allocated on edge node", 
      "type": "array"
    }, 
    "allocation_pools": {
      "description": "Allocation details of pools defined on the edge node.", 
      "items": {
        "$ref": "AllocationPool
      }, 
      "readonly": true, 
      "title": "Pool Allocation details", 
      "type": "array"
    }, 
    "member_index": {
      "description": "System generated index for transport node backed by edge node.", 
      "readonly": true, 
      "title": "System generated index for cluster member", 
      "type": "int"
    }, 
    "node_display_name": {
      "description": "Display name of edge cluster member. Defaults to ID if not set.", 
      "readonly": true, 
      "title": "Identifier to use when displaying cluster member in logs or GUI", 
      "type": "string"
    }, 
    "node_id": {
      "description": "System allotted UUID of edge node.", 
      "readonly": true, 
      "title": "Unique identifier of edge node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeNode (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Node
  }, 
  "id": "EdgeNode", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EdgeNode"
  }, 
  "properties": {
    "allocation_list": {
      "description": "List of logical router ids to which this edge node is allocated.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Allocation list", 
      "type": "array"
    }, 
    "deployment_config": {
      "$ref": "EdgeNodeDeploymentConfig, 
      "description": "When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE will be deployed and registered with MP.", 
      "required": false, 
      "title": "Config for automatic deployment of edge node virtual machine."
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType, 
      "readonly": true, 
      "required": false
    }, 
    "description": {
      "can_sort": true, 
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'display_name' must be used instead. For HostNode, this field defaults to ID if not set. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "description": "Unique identifier of this resource.", 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "node_settings": {
      "$ref": "EdgeNodeSettings, 
      "description": "Reports the current configuration of host name, SSH and servers configured for DNS, syslog, NTP. The settings are configured as part of automatic deployment of edge virtual machine. The settings are editable.", 
      "required": true, 
      "title": "Current configuration on edge node."
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeNodeDeploymentConfig (type)

{
  "additionalProperties": false, 
  "id": "EdgeNodeDeploymentConfig", 
  "module_id": "FabricNode", 
  "properties": {
    "form_factor": {
      "$ref": "EdgeFormFactor, 
      "default": "MEDIUM", 
      "required": false
    }, 
    "node_user_settings": {
      "$ref": "NodeUserSettings, 
      "description": "Username and password settings for the node. Note - these settings will be honored only during node deployment. Post deployment, CLI must be used for changing the user settings, changes to these parameters will not have any effect.", 
      "required": true, 
      "title": "Node user settings"
    }, 
    "vm_deployment_config": {
      "$ref": "DeploymentConfig, 
      "required": true
    }
  }, 
  "type": "object"
}

EdgeNodeRefreshRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "EdgeNodeRefreshRequestParameters", 
  "module_id": "TransportNodeLcm", 
  "properties": {
    "read_only": {
      "default": false, 
      "description": "If readonly is true, then internal objects like resource reservation, allocation etc are updated. Note that Edge transport node intent is not updated. If it is false or if not set, then internal objects and Edge transport node intent both are updated", 
      "required": false, 
      "title": "Read-only flag for Refresh API", 
      "type": "boolean"
    }
  }, 
  "title": "Parameters for Edge node refresh request", 
  "type": "object"
}

EdgeNodeServiceLoggingProperties (type)

{
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "EdgeNodeServiceLoggingProperties", 
  "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"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "logging_level": {
        "enum": [
          "OFF", 
          "FATAL", 
          "ERROR", 
          "WARN", 
          "INFO", 
          "DEBUG", 
          "TRACE"
        ], 
        "required": true, 
        "title": "Service logging level", 
        "type": "string"
      }
    }
  }, 
  "title": "Edge node service properties", 
  "type": "object"
}

EdgeNodeServiceLoggingReadOnlyProperties (type)

{
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "EdgeNodeServiceLoggingReadOnlyProperties", 
  "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"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "logging_level": {
        "enum": [
          "OFF", 
          "FATAL", 
          "ERROR", 
          "WARN", 
          "INFO", 
          "DEBUG", 
          "TRACE"
        ], 
        "readonly": true, 
        "required": true, 
        "title": "Service logging level", 
        "type": "string"
      }
    }
  }, 
  "title": "Edge node service properties", 
  "type": "object"
}

EdgeNodeSettings (type)

{
  "additionalProperties": false, 
  "description": "The settings are used during deployment and consequent update of an edge, unless indicated otherwise. These settings are editable for manually deployed edge nodes as well. If using DHCP, you must leave the following fields unset: search_domains, management_port_subnets, dns_servers and default_gateway_addresses. EdgeNodeSettings reports current values configured on the edge node. If the settings lag with actual state on the edge, these may be refreshed at NSX Manager using API POST api/v1/transport-nodes /<transport-node-id>?action=refresh_node_configuration&resource_type= EdgeNode", 
  "id": "EdgeNodeSettings", 
  "module_id": "FabricNode", 
  "properties": {
    "advanced_configuration": {
      "description": "Array of additional specific properties for advanced or cloud- specific deployments in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Advanced configuration", 
      "type": "array"
    }, 
    "allow_ssh_root_login": {
      "default": false, 
      "description": "Allowing root SSH logins is not recommended for security reasons. Edit of this property is not supported when updating transport node. Use the CLI to change this property.", 
      "required": false, 
      "title": "Allow root SSH logins.", 
      "type": "boolean"
    }, 
    "dns_servers": {
      "description": "List of DNS servers.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "required": false, 
      "title": "DNS servers.", 
      "type": "array"
    }, 
    "enable_ssh": {
      "default": false, 
      "description": "Enabling SSH service is not recommended for security reasons.", 
      "required": false, 
      "title": "Enable SSH.", 
      "type": "boolean"
    }, 
    "enable_upt_mode": {
      "default": false, 
      "description": "Enable Uniform Passthrough ( UPT ) on VMXNET 3 devices to improve overall system performance and reduces latency. Caution: This involves restart of the edge dataplane and hence may lead to network disruption. Use GET api/v1/transport-nodes/<transport-node-id>/state to monitor realization of UPT.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable Uniform Passthrough mode.", 
      "type": "boolean"
    }, 
    "hostname": {
      "pattern": "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*?$", 
      "required": true, 
      "title": "Host name or FQDN for edge node.", 
      "type": "string"
    }, 
    "ntp_servers": {
      "description": "List of NTP servers.", 
      "items": {
        "$ref": "HostnameOrIPAddress
      }, 
      "required": false, 
      "title": "NTP servers.", 
      "type": "array"
    }, 
    "search_domains": {
      "description": "List of domain names that are used to complete unqualified host names.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Search domain names.", 
      "type": "array"
    }, 
    "syslog_servers": {
      "description": "List of Syslog server configuration.", 
      "items": {
        "$ref": "SyslogConfiguration
      }, 
      "maxItems": 5, 
      "required": false, 
      "title": "Syslog servers", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeTransportNodeDatapathMemoryPoolUsage (type)

{
  "additionalProperties": false, 
  "description": "Datapath memory pool usage value.", 
  "id": "EdgeTransportNodeDatapathMemoryPoolUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "description": {
      "description": "Description of the memory pool.", 
      "readonly": true, 
      "title": "Description of the memory pool", 
      "type": "string"
    }, 
    "name": {
      "description": "Name of the datapath memory pool as available on edge node CLI.", 
      "readonly": true, 
      "title": "Name of the datapath memory pool", 
      "type": "string"
    }, 
    "usage": {
      "description": "Percentage of memory pool in use.", 
      "readonly": true, 
      "title": "Percentage of memory pool in use", 
      "type": "number"
    }
  }, 
  "title": "Usage of datapath memory pool", 
  "type": "object"
}

EdgeTransportNodeDatapathMemoryUsage (type)

{
  "additionalProperties": false, 
  "description": "Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.", 
  "id": "EdgeTransportNodeDatapathMemoryUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "datapath_heap_usage": {
      "description": "Percentage of heap memory in use.", 
      "readonly": true, 
      "title": "Percentage of heap memory in use", 
      "type": "number"
    }, 
    "datapath_mem_pools_usage": {
      "items": {
        "$ref": "EdgeTransportNodeDatapathMemoryPoolUsage, 
        "description": "Per memory pool percentage in use.", 
        "readonly": true, 
        "title": "Per memory pool percentage in use"
      }, 
      "type": "array"
    }, 
    "highest_datapath_mem_pool_usage": {
      "description": "Highest percentage usage value among datapath memory pools.", 
      "readonly": true, 
      "title": "Highest percentage usage value among datapath memory pools", 
      "type": "number"
    }, 
    "highest_datapath_mem_pool_usage_names": {
      "items": {
        "description": "List of datapath memory pool(s) with highest usage.", 
        "readonly": true, 
        "title": "Datapath memory pool(s) with highest usage", 
        "type": "string"
      }, 
      "type": "array"
    }
  }, 
  "title": "Detailed view of the datapath memory usage. Details out the heap and per memory pool usage", 
  "type": "object"
}

EdgeTransportNodeMemoryUsage (type)

{
  "additionalProperties": false, 
  "description": "Point in time usage of system, datapath, swap and cache memory in edge node.", 
  "id": "EdgeTransportNodeMemoryUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "cache_usage": {
      "description": "Percentage of RAM on the system that can be flushed out to disk.", 
      "readonly": true, 
      "title": "Percentage of RAM on the system that can be flushed out to disk", 
      "type": "number"
    }, 
    "datapath_mem_usage_details": {
      "$ref": "EdgeTransportNodeDatapathMemoryUsage, 
      "description": "Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.", 
      "readonly": true, 
      "title": "Detailed view of the datapath memory usage. Details out the heap and per memory pool usage"
    }, 
    "datapath_total_usage": {
      "description": "Percentage of memory in use by datapath processes which includes RES and hugepage memory.", 
      "readonly": true, 
      "title": "Percentage of memory in use by datapath processes", 
      "type": "number"
    }, 
    "swap_usage": {
      "description": "Percentage of swap disk in use.", 
      "readonly": true, 
      "title": "Percentage of swap disk in use", 
      "type": "number"
    }, 
    "system_mem_usage": {
      "description": "Percentage of RAM in use on edge node.", 
      "readonly": true, 
      "title": "Percentage of RAM in use on edge node", 
      "type": "number"
    }
  }, 
  "title": "Memory usage details of edge node", 
  "type": "object"
}

EdgeUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus
  }, 
  "id": "EdgeUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_rollback": {
      "description": "This field indicates whether we can perform upgrade rollback.", 
      "readonly": true, 
      "required": false, 
      "title": "Can perform rollback", 
      "type": "boolean"
    }, 
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "title": "Status of edge upgrade", 
  "type": "object"
}

EffectiveIPAddressMemberListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EffectiveIPAddressMemberListResult", 
  "module_id": "NSGroup", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPElement
      }, 
      "required": true, 
      "title": "Paged Collection of effective ip addresses for the given NSGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EffectiveIPInfo (type)

{
  "additionalProperties": false, 
  "id": "EffectiveIPInfo", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "effective_ips": {
      "items": {
        "$ref": "IPElement
      }, 
      "required": true, 
      "type": "array"
    }, 
    "site_id": {
      "required": true, 
      "title": "Id of the site to which the effective IPs belong to\n", 
      "type": "string"
    }
  }, 
  "title": "List of effective ip address along with site id", 
  "type": "object"
}

EffectiveMemberResourceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EffectiveMemberResourceListResult", 
  "module_id": "NSGroup", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ResourceReference, 
        "title": "effective members resource list results"
      }, 
      "required": true, 
      "title": "Paged Collection of resources which are the effective members of an NSGroup.", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EffectiveMemberTypeListResult (type)

{
  "additionalProperties": false, 
  "id": "EffectiveMemberTypeListResult", 
  "module_id": "NSGroup", 
  "properties": {
    "result_count": {
      "readonly": true, 
      "required": true, 
      "title": "Count of the member types in the results array", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSGroupValidResourceType
      }, 
      "required": true, 
      "title": "Collection of member types for the given NSGroup", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EffectiveProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EffectiveProfileListResult", 
  "module_id": "ServiceConfig", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSXProfileReference
      }, 
      "required": true, 
      "title": "Paged Collection of profiles which are applied to an Entity", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EffectiveProfileRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "EffectiveProfileRequestParameters", 
  "module_id": "ServiceConfig", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "profile_type": {
      "required": false, 
      "title": "Fetch effectivw profiles of the given profile_type", 
      "type": "string"
    }, 
    "resource_id": {
      "required": true, 
      "title": "The resource for which the effective profiles are to be fetched", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "EffectiveProfileResourceType, 
      "required": true, 
      "title": "Type of the resource for which effective profiles are to be fetched"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EffectiveProfileResourceType (type)

{
  "description": "This enum defines the valid Resource types to be used in effective profiles API", 
  "enum": [
    "NSGroup", 
    "LogicalPort", 
    "VirtualMachine", 
    "TransportNode", 
    "LogicalRouter", 
    "LogicalSwitch"
  ], 
  "id": "EffectiveProfileResourceType", 
  "module_id": "ServiceConfig", 
  "title": "Valid Resource type in effective profiles API", 
  "type": "string"
}

EffectiveProfilesResponse (type)

{
  "additionalProperties": false, 
  "id": "EffectiveProfilesResponse", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "profiles_list": {
      "items": {
        "$ref": "SwitchingProfileTypeIdEntry
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "title": "Enforcement point request entity", 
  "type": "object"
}

EgressRateLimiter (type)

{
  "extends": {
    "$ref": "QoSBaseRateLimiter
  }, 
  "id": "EgressRateLimiter", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EgressRateLimiter"
  }, 
  "properties": {
    "average_bandwidth": {
      "default": 0, 
      "descrption": "Set custom average_bandwidth for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size": {
      "default": 0, 
      "descrption": "Set custom burst_size for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth": {
      "default": 0, 
      "descrption": "Set custom peak_bandwidth for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateLimiter", 
      "description": "Type rate limiter", 
      "enum": [
        "IngressRateLimiter", 
        "IngressBroadcastRateLimiter", 
        "EgressRateLimiter"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies egress rate properties in Mb/s", 
  "type": "object"
}

EgressRateShaper (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "QosBaseRateShaper
  }, 
  "id": "EgressRateShaper", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EgressRateShaper"
  }, 
  "properties": {
    "average_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size_bytes": {
      "default": 0, 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateShaper", 
      "enum": [
        "IngressRateShaper", 
        "IngressBroadcastRateShaper", 
        "EgressRateShaper"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies egress rate properties in Mb/s", 
  "type": "object"
}

EmbeddedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource
  }, 
  "id": "EmbeddedResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "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"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_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"
    }, 
    "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": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }
  }, 
  "title": "Base class for resources that are embedded in other resources", 
  "type": "object"
}

EncapsulationType (type)

{
  "additionalProperties": false, 
  "description": "You can choose the encapsulation type of the mirroring, now we support GRE, ERSPAN II and ERSPAN III.", 
  "enum": [
    "GRE", 
    "ERSPAN_TWO", 
    "ERSPAN_THREE"
  ], 
  "id": "EncapsulationType", 
  "module_id": "PortMirroring", 
  "title": "Encapsulation type for L3PortMirrorSession", 
  "type": "string"
}

Endpoint (type)

{
  "description": "An Endpoint object is part of HostSwitch configuration in TransportNode", 
  "id": "Endpoint", 
  "module_id": "TransportNode", 
  "properties": {
    "default_gateway": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "title": "Gateway IP"
    }, 
    "device_name": {
      "readonly": true, 
      "title": "Name of the virtual tunnel endpoint", 
      "type": "string"
    }, 
    "ip": {
      "$ref": "IPAddress, 
      "description": "Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.", 
      "readonly": true, 
      "title": "IP Address of this virtual tunnel endpoint"
    }, 
    "label": {
      "readonly": true, 
      "required": false, 
      "title": "Unique label for this Endpoint", 
      "type": "int"
    }, 
    "mac": {
      "$ref": "MACAddress, 
      "readonly": true, 
      "title": "MAC address"
    }, 
    "subnet_mask": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "title": "Subnet mask"
    }
  }, 
  "title": "Tunnel endpoint configuration", 
  "type": "object"
}

EndpointPolicy (type)

{
  "additionalProperties": false, 
  "description": "Ordered list of Endpoint Rules ordered by sequence number of the entries. The maximum number of policies is 25.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EndpointPolicy", 
  "module_id": "PolicyGuestIntrospection", 
  "policy_hierarchical_children": [
    "ChildEndpointRule"
  ], 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "endpoint_rules": {
      "items": {
        "$ref": "EndpointRule
      }, 
      "required": false, 
      "title": "Endpoint Rules that are a part of this EndpointPolicy", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequence_number": {
      "default": 0, 
      "description": "This field is used to resolve conflicts between maps across domains.", 
      "maximum": 499, 
      "minimum": 0, 
      "required": false, 
      "title": "Precedence to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Contains ordered list of Endpoint Rules\n", 
  "type": "object"
}

EndpointPolicyListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "EndpointPolicyListRequestParameters", 
  "module_id": "PolicyGuestIntrospection", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "EndpointPolicy list request parameters", 
  "type": "object"
}

EndpointPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EndpointPolicyListResult", 
  "module_id": "PolicyGuestIntrospection", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EndpointPolicy
      }, 
      "required": true, 
      "title": "Guest Introspection Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Groups", 
  "type": "object"
}

EndpointRule (type)

{
  "additionalProperties": false, 
  "description": "Endpoint Rule comes from user configuration. User configures Endpoint Rule to specify what services are applied on the groups.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EndpointRule", 
  "module_id": "PolicyGuestIntrospection", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "group paths", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "EndpointRule"
          ], 
          "relationshipType": "GI_ENTRY_GROUP_RELATIONSHIP", 
          "rightType": [
            "Group"
          ]
        }
      ]
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequence_number": {
      "default": 0, 
      "description": "This field is used to resolve conflicts between multiple entries under EndpointPolicy. It will be system default value when not specified by user.", 
      "maximum": 499, 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of this Entry", 
      "type": "int"
    }, 
    "service_profiles": {
      "description": "The policy paths of service profiles are listed here. It pecifies what services are applied on the group. Currently only one is allowed.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": true, 
      "title": "Names of service profiles", 
      "type": "array", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "EndpointRule"
          ], 
          "relationshipType": "GI_ENTRY_SERVICE_RELATIONSHIP", 
          "rightType": [
            "PolicyServiceProfile"
          ]
        }
      ]
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Endpoint Rule for guest introspection.", 
  "type": "object"
}

EndpointRuleListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "EndpointRuleListRequestParameters", 
  "module_id": "PolicyGuestIntrospection", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Endpoint Rule list request parameters", 
  "type": "object"
}

EndpointRuleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EndpointRuleListResult", 
  "module_id": "PolicyGuestIntrospection", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EndpointRule
      }, 
      "required": true, 
      "title": "Endpoint Rule list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Endpoint Rules", 
  "type": "object"
}

EnforcedStatusDetailsNsxT (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status of an intent object on an NSX-T type of enforcement point. This is a detailed view of the Realized Status of an intent object from an NSX-T enforcement point perspective.", 
  "id": "EnforcedStatusDetailsNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "enforced_status_info": {
      "$ref": "EnforcedStatusInfoNsxT, 
      "description": "Information about the realized status of the intent on this enforcement point. Some very recent changes may be excluded when preparing this information, which is indicated by Pending Changes Info.", 
      "readonly": true, 
      "title": "Enforced Realized Status Info"
    }, 
    "pending_changes_info": {
      "$ref": "PendingChangesInfoNsxT, 
      "description": "Information about pending changes, if any, that aren't reflected in the Enforced Realized Status.", 
      "readonly": true, 
      "title": "Pending Changes Info"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Details", 
  "type": "object"
}

EnforcedStatusInfoNsxT (type)

{
  "additionalProperties": false, 
  "description": "Information about the realized status of the intent object on an NSX-T type of enforcement point. Some very recent changes may be excluded when preparing this information, which is indicated by Pending Changes Info. In addition to the realized status across all scopes, this information holds details about enforced realized status per scope.", 
  "id": "EnforcedStatusInfoNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "enforced_status": {
      "$ref": "EnforcedStatusNsxT, 
      "description": "Consolidated Realized Status of an Intent object across all scopes of an NSX-T type of enforcement point.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "enforced_status_per_scope": {
      "description": "List of Enforced Realized Status per Scope.", 
      "items": {
        "$ref": "EnforcedStatusPerScopeNsxT
      }, 
      "readonly": true, 
      "title": "List of Enforced Realized Status per Scope", 
      "type": "array"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Information", 
  "type": "object"
}

EnforcedStatusNsxT (type)

{
  "additionalProperties": false, 
  "description": "NSX-T Enforced Status.", 
  "id": "EnforcedStatusNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "status": {
      "$ref": "RuntimeState, 
      "description": "Enforced Realized Status.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "status_message": {
      "description": "Status Message conveying hints depending on the status value.", 
      "readonly": true, 
      "title": "Status Message", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Enforced Status", 
  "type": "object"
}

EnforcedStatusPerScopeNsxT (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "NSX-T Detailed Realized Status Per Scope.", 
  "id": "EnforcedStatusPerScopeNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Enforced Realized Status Per Scope Resource Type.", 
      "enum": [
        "TransportNodeSpanEnforcedStatus"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Per Scope", 
  "type": "object"
}

EnforcedStatusPerTransportNode (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status Per Transport Node.", 
  "id": "EnforcedStatusPerTransportNode", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "display_name": {
      "description": "Display name of the transport node.", 
      "readonly": true, 
      "title": "Transport Node Display Name", 
      "type": "string"
    }, 
    "enforced_status": {
      "$ref": "EnforcedStatusNsxT, 
      "description": "Realized Status of an Intent object on this Transport Node.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "nsx_id": {
      "description": "UUID identifying uniquely the Transport Node.", 
      "readonly": true, 
      "title": "Transport Node Identifier", 
      "type": "string"
    }, 
    "path": {
      "description": "Policy Path referencing the transport node.", 
      "readonly": true, 
      "title": "Transport Node Path", 
      "type": "string"
    }
  }, 
  "title": "Enforced Realized Status Per Transport Node", 
  "type": "object"
}

EnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Enforcement point is the endpoint where policy configurations are applied.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EnforcementPoint", 
  "module_id": "PolicyEnforcementPointManagement", 
  "policy_hierarchical_children": [
    "ChildClusterControlPlane", 
    "ChildHostTransportNode", 
    "ChildHostTransportNodeCollection", 
    "ChildPolicyEdgeCluster", 
    "ChildPolicyTransportZone", 
    "ChildSubCluster"
  ], 
  "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"
    }, 
    "auto_enforce": {
      "default": true, 
      "description": "Auto enforce flag suggests whether the policy objects shall be automatically enforced on this enforcement point or not. When this flag is set to true, all policy objects will be automatically enforced on this enforcement point. If this flag is set to false, user shall rely on the usual means of realization, i.e., deployment maps.", 
      "title": "Auto Enforce Flag", 
      "type": "boolean"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connection_info": {
      "$ref": "EnforcementPointConnectionInfo, 
      "description": "Connection Info of the Enforcement Point.", 
      "required": true, 
      "title": "Enforcement Point Connection Info"
    }, 
    "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"
    }, 
    "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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"
    }, 
    "version": {
      "description": "Version of the Enforcement point.", 
      "readonly": true, 
      "title": "Enforcement point Version", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point", 
  "type": "object"
}

EnforcementPointConnectionInfo (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Contains information required to connect to enforcement point.", 
  "id": "EnforcementPointConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo", 
        "AviConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point Connection Info", 
  "type": "object"
}

EnforcementPointListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Enforcement point list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "EnforcementPointListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point List Request Parameters", 
  "type": "object"
}

EnforcementPointListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of enforcement points.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EnforcementPointListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Enforcement Point list Results.", 
      "items": {
        "$ref": "EnforcementPoint
      }, 
      "required": true, 
      "title": "Enforcement Point List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of EnforcementPoints", 
  "type": "object"
}

EnforcementPointRequest (type)

{
  "additionalProperties": false, 
  "id": "EnforcementPointRequest", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path of enforcement point on request is to be made.", 
      "title": "Enforcement point path", 
      "type": "string"
    }
  }, 
  "title": "Enforcement point request entity", 
  "type": "object"
}

EntitlementSpec (type)

{
  "description": "EntitlementSpec contains full set of subscription offers. EntitlementSpec can be pushed from Entitlement Service to licensing service.", 
  "id": "EntitlementSpec", 
  "module_id": "License", 
  "properties": {
    "instance_id": {
      "description": "The identifier for an instance. An instance is a set of Sites(On-Prem LMs) or SDDCs.", 
      "readonly": true, 
      "title": "Instance ID", 
      "type": "string"
    }, 
    "offers": {
      "description": "Subscription offers which will be used for the licensing entitlement.", 
      "items": {
        "$ref": "LicenseOffer
      }, 
      "readonly": true, 
      "title": "Subscription offers", 
      "type": "array"
    }, 
    "org_id": {
      "description": "The identifier for an org. An org is a CSP tenant. Every service runs in the context of an org within CSP.", 
      "readonly": true, 
      "title": "Orgnization ID", 
      "type": "string"
    }, 
    "site_id": {
      "description": "Policy Local Manager site id.", 
      "readonly": true, 
      "title": "Site ID", 
      "type": "string"
    }
  }, 
  "title": "Entitlement Spec", 
  "type": "object"
}

EntityInstanceCountConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level constraint to restrict the number of instances of an entity type that can be created. Lowering the limit on the number of instances of a given type is allowed even in cases where there are instances more than the specified limit already in the system. In this case, creation of new instances of that type will be disallowed unless the number of instances goes below the limit. One of the main usage of this expression is to implement Quotas in the multi-tenancy context. It allows to limit the number of resources which can be created inside a Project. It also allows to forbid consumption of specific resource by putting its entity count to 0. Note that, update/delete operations will continue to be allowed on already created instances.", 
  "extends": {
    "$ref": "ConstraintExpression
  }, 
  "id": "EntityInstanceCountConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EntityInstanceCountConstraintExpression"
  }, 
  "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"
    }, 
    "count": {
      "description": "Instance count.", 
      "required": true, 
      "title": "Instance count.", 
      "type": "integer"
    }, 
    "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"
    }, 
    "operator": {
      "required": true, 
      "title": "Operations supported '<' and '<='.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_resource_type": {
      "description": "The resource type", 
      "required": false, 
      "title": "Resource type of the target entity. This needs to be set for all\ncases where the target does not specify the type.\n", 
      "type": "string"
    }
  }, 
  "title": "Represents the leaf level constraint to restrict the number instances of type.", 
  "type": "object"
}

EpochMsTimestamp (type)

{
  "id": "EpochMsTimestamp", 
  "module_id": "Common", 
  "title": "Timestamp in milliseconds since epoch", 
  "type": "integer"
}

ErrorInfo (type)

{
  "additionalProperties": false, 
  "id": "ErrorInfo", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "error_code": {
      "description": "Error code of the error.", 
      "readonly": false, 
      "required": false, 
      "title": "Error code", 
      "type": "int"
    }, 
    "error_message": {
      "readonly": true, 
      "required": true, 
      "title": "Error message", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp when the error occurred"
    }
  }, 
  "title": "Error information", 
  "type": "object"
}

ErrorResolverInfo (type)

{
  "additionalProperties": false, 
  "description": "Metadata related to a given error_id", 
  "id": "ErrorResolverInfo", 
  "module_id": "ErrorResolver", 
  "properties": {
    "error_id": {
      "required": true, 
      "title": "The error id for which metadata information is needed", 
      "type": "integer"
    }, 
    "resolver_present": {
      "required": true, 
      "title": "Indicates whether there is a resolver associated with the error or not", 
      "type": "boolean"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverInfoList (type)

{
  "additionalProperties": false, 
  "id": "ErrorResolverInfoList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "results": {
      "items": {
        "$ref": "ErrorResolverInfo
      }, 
      "required": true, 
      "title": "ErrorResolverInfo list", 
      "type": "array"
    }
  }, 
  "title": "Collection of all registered ErrorResolverInfo", 
  "type": "object"
}

ErrorResolverMetadata (type)

{
  "additionalProperties": false, 
  "description": "Error along with its metadata", 
  "id": "ErrorResolverMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "entity_id": {
      "required": true, 
      "title": "The entity/node UUID where the error has occurred.", 
      "type": "string"
    }, 
    "error_id": {
      "required": true, 
      "title": "The error id as reported by the entity where the error occurred.", 
      "type": "integer"
    }, 
    "system_metadata": {
      "$ref": "ErrorResolverSystemMetadata, 
      "required": false, 
      "title": "This can come from some external system like syslog collector"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverMetadataList (type)

{
  "additionalProperties": false, 
  "description": "List of errors with their metadata", 
  "id": "ErrorResolverMetadataList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "errors": {
      "items": {
        "$ref": "ErrorResolverMetadata
      }, 
      "required": true, 
      "title": "List of errors with their corresponding metadata.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ErrorResolverSystemMetadata (type)

{
  "additionalProperties": false, 
  "description": "Metadata fetched from an external system like Syslog or LogInsight.", 
  "id": "ErrorResolverSystemMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "value": {
      "required": false, 
      "title": "The value fetched from another system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserInputData (type)

{
  "additionalProperties": false, 
  "description": "Corresponds to one property entered by the user", 
  "id": "ErrorResolverUserInputData", 
  "module_id": "ErrorResolver", 
  "properties": {
    "data_type": {
      "enum": [
        "TEXT", 
        "NUMBER", 
        "PASSWORD"
      ], 
      "required": true, 
      "title": "The datatype of the given property. Useful for data validation", 
      "type": "string"
    }, 
    "property_name": {
      "required": true, 
      "title": "Name of the property supplied by the user", 
      "type": "string"
    }, 
    "property_value": {
      "required": false, 
      "title": "The value associated with the above property", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserMetadata (type)

{
  "additionalProperties": false, 
  "description": "User supplied metadata needed for resolving errors", 
  "id": "ErrorResolverUserMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "user_input_list": {
      "items": {
        "$ref": "ErrorResolverUserInputData
      }, 
      "required": false, 
      "title": "List of user supplied input data.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EsgToRouterMappingOptionSpec (type)

{
  "additionalProperties": false, 
  "description": "Spec for NSX-V ESG to NSX-T Router mapping option.", 
  "id": "EsgToRouterMappingOptionSpec", 
  "module_id": "Migration", 
  "properties": {
    "mapping_option": {
      "description": "Mapping option can be - - UI - FILE_UPLOAD - NO_MAPPING", 
      "enum": [
        "UI", 
        "FILE_UPLOAD", 
        "NO_MAPPING"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Mapping option", 
      "type": "string"
    }
  }, 
  "title": "Spec for NSX-V ESG to NSX-T Router mapping option", 
  "type": "object"
}

EsxGlobalOpaqueConfig (type)

{
  "extends": {
    "$ref": "GlobalConfigs
  }, 
  "id": "EsxGlobalOpaqueConfig", 
  "module_id": "GlobalConfigs", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EsxGlobalOpaqueConfig"
  }, 
  "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"
    }, 
    "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"
    }, 
    "opaque_config": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "required": true, 
      "title": "A list of global opaque configuration for ESX hosts.", 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "GlobalConfigType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "ESX global opaque configuration", 
  "type": "object"
}

EtherTypeNSService (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement
  }, 
  "id": "EtherTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EtherTypeNSService"
  }, 
  "properties": {
    "ether_type": {
      "required": true, 
      "title": "Type of the encapsulated protocol", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "An NSService element that represents an ethertype protocol", 
  "type": "object"
}

EtherTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "EtherTypeServiceEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EtherTypeServiceEntry"
  }, 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "ether_type": {
      "required": true, 
      "title": "Type of the encapsulated protocol", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "A ServiceEntry that represents an ethertype protocol", 
  "type": "object"
}

EthernetHeader (type)

{
  "additionalProperties": false, 
  "id": "EthernetHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_mac": {
      "description": "The destination MAC address of form: \"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.", 
      "required": false, 
      "title": "Destination MAC address of the Ethernet header", 
      "type": "string"
    }, 
    "eth_type": {
      "default": 2048, 
      "description": "This field defaults to IPv4.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "The value of the type field to be put into the Ethernet header", 
      "type": "integer"
    }, 
    "src_mac": {
      "description": "The source MAC address of form: \"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.", 
      "required": false, 
      "title": "Source MAC address of the Ethernet header", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Evaluation (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Criterion Evaluation is the basic logical condition to evaluate whether the event could be potentially met.", 
  "id": "Evaluation", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Criterion Evaluation resource type.", 
      "enum": [
        "SourceFieldEvaluation"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Criterion Evaluation", 
  "type": "object"
}

Event (type)

{
  "additionalProperties": false, 
  "description": "The Event is the criterion or criteria applied to the source and, when met, prompt Policy to run the action. All Reaction Events are constructed with reference to the object, the \"source\", that is logically deemed to be the object upon which the Event in question initially occurred upon. Some example events include: - New object was created. - Change in realization state. - Specific API is called.", 
  "id": "Event", 
  "module_id": "PolicyReaction", 
  "properties": {
    "criteria": {
      "description": "Criteria applied to the source and, if satisfied, would trigger the action. Criteria is composed of criterions. In order for the Criteria to be met, only one of the criterion must be fulfilled (implicit OR).", 
      "items": {
        "$ref": "Criterion
      }, 
      "title": "Event Criteria", 
      "type": "array"
    }, 
    "source": {
      "$ref": "Source, 
      "description": "Source that is logically deemed to be the \"object\" upon which the Event in question initially occurred upon.", 
      "required": true, 
      "title": "Event Source"
    }
  }, 
  "title": "Reaction Event", 
  "type": "object"
}

EventListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EventListResult", 
  "module_id": "Monitoring", 
  "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"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MonitoringEvent
      }, 
      "readonly": true, 
      "title": "List of events defined", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EvpnConfig (type)

{
  "additionalProperties": false, 
  "description": "Evpn Configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "advanced_config": {
      "$ref": "EvpnConfigAdvancedConfig, 
      "description": "Advanced configuration for evpn config.", 
      "required": false, 
      "title": "Advanced configuration for evpn config"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "encapsulation_method": {
      "$ref": "EvpnEncapConfig, 
      "description": "Encapsulation method for EVPN service that is used by the transport layer.", 
      "required": false, 
      "title": "Encapsulation method for EVPN."
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "mode": {
      "default": "DISABLE", 
      "description": "In INLINE mode, edge nodes participate both in the BGP EVPN control plane route exchange and in data path tunneling between edge nodes and data center gateways. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in the data forwarding, i.e., the data path tunnels are directly established between the hypervisors and the data center gateways. DISABLE mode disables EVPN service capability.", 
      "enum": [
        "INLINE", 
        "ROUTE_SERVER", 
        "DISABLE"
      ], 
      "required": false, 
      "title": "EVPN service mode", 
      "type": "string"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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"
    }, 
    "owner_id": {
      "description": "This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for the ownership of an object", 
      "type": "string"
    }, 
    "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"
    }, 
    "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"
    }, 
    "remote_path": {
      "description": "This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.", 
      "readonly": true, 
      "required": false, 
      "title": "Path of the object on the remote end.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "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": "Evpn Configuration", 
  "type": "object"
}

EvpnConfigAdvancedConfig (type)

{
  "additionalProperties": false, 
  "description": "NSX specific configuration for evpn config", 
  "id": "EvpnConfigAdvancedConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {}, 
  "title": "Advanced configuration for evpn config", 
  "type": "object"
}

EvpnEncapConfig (type)

{
  "additionalProperties": false, 
  "description": "Encapsulation method for EVPN.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnEncapConfig", 
  "module_id": "PolicyConnectivity", 
  "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"
    }, 
    "children": {
      "description": "Subtree for this type within policy tree containing nested elements. Note that  this type is applicable to be used in Hierarchical API only.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "Subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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"
    }, 
    "evpn_tenant_config_path": {
      "required": false, 
      "title": "EVPN tenant config path", 
      "type": "string", 
      "x-vmw-cross-reference": [
        {
          "leftType": [
            "EvpnConfig"
          ], 
          "relationshipType": "EVPN_CONFIG_TENANT_CONFIG_RELATIONSHIP", 
          "rightType": [
            "EvpnTenantConfig"
          ]
        }
      ]
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "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"
    }, 
    "origin_site_id": {
      "description": "This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system for knowing which site owns an object", 
      "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 define