NSX-T Data Center REST API

Get the security feature license usage report.

Get the security feature license usage report.

Request:

Method:
GET
URI Path(s):
/api/v1/licenses/security-usage
Request Headers:
n/a
Query Parameters:
SecurityLicenseUsageRequestParameters+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SecurityLicenseUsageReport+

Example Response:

{ "core_count_by_edition": [ { "raw_core_count_by_type": { "compute_cores": "160", "dpu_units": "0" }, "product_family": "VMware vDefend Firewall with Advanced Threat Prevention", "total_raw_core": "160", "total_licensed_core_count": "2560", "features_in_use": [ "DISTRIBUTED_INTELLIGENCE", "DISTRIBUTED_FIREWALL", "NETWORK_DETECTION_RESPONSE", "DISTRIBUTED_MPS" ] }, { "raw_core_count_by_type": { "gateway_cores": "16" }, "product_family": "VMware vDefend Firewall", "total_raw_core": "16", "total_licensed_core_count": "64", "features_in_use": [ "GATEWAY_IDPS", "GATEWAY_MPS", "GATEWAY_FIREWALL" ] } ], "core_count_by_feature": { "raw_core_counts": { "DISTRIBUTED_FIREWALL": "160", "DISTRIBUTED_BAREMETAL": "0", "DISTRIBUTED_INTELLIGENCE": "160", "DISTRIBUTED_INTELLIGENCE_BAREMETAL": "0", "DISTRIBUTED_IPFIX": "0", "DISTRIBUTED_IPFIX_BAREMETAL": "0", "DISTRIBUTED_IDPS": "0", "DISTRIBUTED_MPS": "40", "GATEWAY_FIREWALL": "16", "GATEWAY_TLS": "0", "GATEWAY_IDPS": "16", "GATEWAY_MPS": "16", "NETWORK_DETECTION_RESPONSE": "160" }, "licensed_core_count": { "DISTRIBUTED_FIREWALL": "2560", "DISTRIBUTED_INTELLIGENCE": "2560", "DISTRIBUTED_INTELLIGENCE_BAREMETAL": "0", "DISTRIBUTED_IPFIX": "0", "DISTRIBUTED_IPFIX_BAREMETAL": "0", "DISTRIBUTED_IDPS": "0", "DISTRIBUTED_MPS": "640", "GATEWAY_FIREWALL": "64", "GATEWAY_TLS": "0", "GATEWAY_IDPS": "64", "GATEWAY_MPS": "64", "NETWORK_DETECTION_RESPONSE": "2560" } }, "node_details" : [ { "node_type" : "EDGE_NODE", "node_id" : "cc4c27be-e967-11ef-8d81-020074875efc", "features_enabled" : [ "GATEWAY_FIREWALL" ], "raw_cores" : "2", "product_family" : "VMware vDefend Firewall", "maintenance_mode" : "ENABLED" }, { "node_type" : "EDGE_NODE", "node_id" : "35ce3097-ed59-4a2c-8f07-eac74e60afda", "compute_manager_id" : "4b3f7f0e-1604-4d4f-b938-7b859071c37d", "vcenter_node_id" : "vm-45", "features_enabled" : [ "" ], "raw_cores" : "2", "product_family" : "VMware vDefend Firewall", "maintenance_mode" : "DISABLED" }, { "node_type" : "ESX", "node_id" : "f0552bbe-69b6-45cb-8cc1-80d0236d9b5c", "compute_manager_id" : "4b3f7f0e-1604-4d4f-b938-7b859071c37d", "vcenter_cluster_id" : "domain-c11", "vcenter_node_id" : "host-14", "features_enabled" : [ "DISTRIBUTED_FIREWALL" ], "raw_cores" : "4", "cpu_socket" : "4", "product_family" : "VMware vDefend Firewall", "maintenance_mode" : "DISABLED" }, { "node_type" : "EDGE_NODE", "node_id" : "cbba9b5a-e967-11ef-bbdd-020074c89a3d", "features_enabled" : [ "GATEWAY_FIREWALL", "GATEWAY_IDPS" ], "raw_cores" : "2", "product_family" : "VMware vDefend Firewall with Advanced Threat Prevention", "maintenance_mode" : "DISABLED" } ], "additional_metadata": { "max_raw_core_count_per_host": "20", "max_raw_core_count_per_socket": "1", "max_socket_count_per_host": "20", "num_edge_small_factor": "0", "num_edge_medium_factor": "0", "num_edge_large_factor": "2", "num_edge_xlarge_factor": "0", "num_edge_baremetal_at_recommended_cores": "0", "num_edge_baremetal_at_minimum_cores": "0", "number_of_nsgroups": "12", "number_of_prepared_hosts": "8", "number_of_virtual_machines": "24", "number_of_tier_0_gateways": "1", "number_of_tier_1_gateways": "3", "number_of_dfw_rules": "11", "number_of_firewall_rules": "16", "intelligence_deployed": "true", "recommendation_sessions_total": "0", "napp_appliance_version": "4.2.0-0.0-24124098", "number_of_ids_gateway_rules": "2", "number_of_ids_security_policies": "1", "mps_total_number_of_profiles": "1", "mps_number_of_dfw_ids_rules_with_custom_mps_profiles": "1", "mps_number_of_gateway_ids_rules_with_custom_mps_profiles": "2", "nta_enabled": "false", "nsx_manager_version": "4.2.1.0.0.24221936", "nsx_deployment_id": "25266463-7773-488b-bac6-c1a9ff6b680e", "nsx_site_id": "16a8118a-a45e-425e-abda-a1c52add0878", "license_edition_type": [ "VMware Advanced Threat Prevention", "VMware Firewall", "vc.vcf", "NSX for vShield Endpoint" ], "license_key": [ "00000-00000-00000-00000-00000", "11111-22222-33333-44444-55555" ], "host_number_of_host_node_cpu_cores": "160", "edge_number_of_edge_node_cpu_cores": "16" }, "last_update_timestamp": 1724799306328 }

Required Permissions:

read

Feature:

security_license_usage

Additional Errors: