NSX-T Data Center REST API

List all Service-Insertion Services.

List all Service-Insertion Service Definitions.

Request:

Method:
GET
URI Path(s):
/api/v1/serviceinsertion/services
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/services

Successful Response:

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

Example Response:

{ "result_count": 3, "results": [{ "functionalities": [ "NG_FW", "BYOD" ], "implementations": [ "NORTH_SOUTH" ], "attachment_point": [ "TIER0_LR" ], "transports": [ "L2_BRIDGE" ], "on_failure_policy": "BLOCK", "vendor_id": "Byod_Service", "resource_type": "ServiceDefinition", "id": "7bf17cb6-cd8f-440f-b1e9-3abdc1375501", "display_name": "NS Byod Service", "description": "This is NorthSouth BYOD Service", "_create_user": "admin", "_create_time": 1546981298714, "_last_modified_user": "admin", "_last_modified_time": 1546981298714, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "ServiceDefinition", "description": "This service is inserted at T0 router and it provides advanced security", "id": "8c3ba6b6-5b64-45ed-8d62-8168b2106c99", "display_name": "NS Service", "attachment_point": [ "TIER0_LR" ], "transports": [ "L2_BRIDGE" ], "functionalities": [ "NG_FW" ], "vendor_id": "ABC_Service", "on_failure_policy": "ALLOW", "service_deployment_spec": { "deployment_specs": [{ "ovf_url": "http://server.com/dir2/ABC_Company-HA-OVF/ABC-VM-ESX-3.0.ovf", "name": "NS_DepSpec", "host_type": "ESXI", "service_form_factor": "MEDIUM" }], "nic_metadata_list": [{ "interface_label": "eth", "interface_index": 2, "interface_type": "DATA2" }, { "interface_label": "eth", "interface_index": 0, "interface_type": "MANAGEMENT" }, { "interface_label": "eth", "interface_index": 1, "interface_type": "DATA1" }, { "interface_label": "eth", "interface_index": 3, "interface_type": "HA1" }, { "interface_label": "eth", "interface_index": 4, "interface_type": "HA2" } ], "deployment_template": [{ "name": "NS_DepTemp", "attributes": [{ "attribute_type": "STRING", "display_name": "License", "key": "LicnseKey" }] }] }, "implementations": [ "NORTH_SOUTH" ], "_create_user": "admin", "_create_time": 1525889017742, "_last_modified_user": "admin", "_last_modified_time": 1525889017742, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "functionalities": [ "NG_FW" ], "implementations": [ "EAST_WEST" ], "attachment_point": [ "SERVICE_PLANE" ], "transports": [ "NSH" ], "service_capability": { "nsh_liveness_support_enabled": true, "can_decrement_si": true }, "on_failure_policy": "BLOCK", "service_deployment_spec": { "deployment_template": [{ "name": "EW_DepTemp", "attributes": [{ "key": "LicnseKey", "display_name": "License", "attribute_type": "STRING" }] }], "deployment_specs": [{ "name": "EW_DepSpec", "ovf_url": "http://server.com/dir2/XYZ_Company-HA-OVF/XYZ-VM-ESX-3.0.ovf", "host_type": "ESXI", "service_form_factor": "MEDIUM" }], "nic_metadata_list": [{ "interface_label": "eth", "interface_index": 0, "interface_type": "MANAGEMENT", "user_configurable": true }, { "interface_label": "eth", "interface_index": 1, "interface_type": "DATA1" } ] }, "vendor_id": "XYZ_Service", "resource_type": "ServiceDefinition", "id": "103ca1c3-ef39-4473-aaec-9a8d764a9392", "display_name": "EW Service_Insertion", "description": "This is East West Service Insertion", "_create_user": "admin", "_create_time": 1546634193749, "_last_modified_user": "admin", "_last_modified_time": 1546634193749, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ] }

Required Permissions:

read

Feature:

service_insertion_config

Additional Errors: