InlineServiceDefinition1

Properties

array of string

functionalities Required

The capabilities provided by the services. Needs to be one or more of the following | NG_FW - Next Generation Firewall | IDS_IPS - Intrusion detection System / Intrusion Prevention System | NET_MON - Network Monitoring | HCX - Hybrid Cloud Exchange | BYOD - Bring Your Own Device | EPP - Endpoint Protection.(Third party AntiVirus partners using NXGI should use this functionality for the service)

Possible values are: NG_FW , IDS_IPS , NET_MON , HCX , BYOD , EPP

array of string

implementations Required

This indicates the insertion point of the service i.e whether the service will be used to protect North-South or East-West traffic in the datacenter.

Possible values are: NORTH_SOUTH , EAST_WEST

string

vendor_id Required

Id which is unique to a vendor or partner for which the service is created.

array of string

attachment_point Optional

The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance. Attachment Point is required if Service caters to any functionality other than EPP.

Possible values are: TIER0_LR , TIER1_LR , SERVICE_PLANE

string

on_failure_policy Optional

Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios. For north-south ServiceInsertion, failure policy in the service instance takes precedence. For east-west ServiceInsertion, failure policy in the service chain takes precedence. BLOCK is not supported for Endpoint protection (EPP) functionality.

Possible values are: ALLOW , BLOCK

ServiceCapability

service_capability Optional

Service capability.

ServiceDeploymentSpec

service_deployment_spec Optional

Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm.

string

service_manager_id Optional

ID of the service manager to which this service is attached with. This field is not set during creation of service. This field will be set explicitly when Service Manager is created successfully using this service.

array of string

transports Optional

Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP.

Possible values are: L2_BRIDGE , L3_ROUTED , NSH

JSON Example

Show optional properties

{
	"functionalities": [
		"NG_FW"
	],
	"implementations": [
		"NORTH_SOUTH"
	],
	"vendor_id": "string"
}

{
	"attachment_point": [
		"TIER0_LR"
	],
	"functionalities": [
		"NG_FW"
	],
	"implementations": [
		"NORTH_SOUTH"
	],
	"on_failure_policy": "ALLOW",
	"service_capability": {
		"can_decrement_si": false,
		"nsh_liveness_support_enabled": false
	},
	"service_deployment_spec": {
		"deployment_specs": [
			{
				"host_type": "ESXI",
				"min_host_version": "string",
				"name": "string",
				"ovf_url": "string",
				"service_form_factor": "SMALL"
			}
		],
		"deployment_template": [
			{
				"attributes": [
					{
						"attribute_type": "IP_ADDRESS",
						"display_name": "string",
						"key": "string",
						"read_only": false,
						"value": "string"
					}
				],
				"name": "string"
			}
		],
		"nic_metadata_list": [
			{
				"interface_index": 0,
				"interface_label": "string",
				"interface_type": "MANAGEMENT",
				"transports": [
					"L2_BRIDGE"
				],
				"user_configurable": false
			}
		],
		"svm_version": "string"
	},
	"service_manager_id": "string",
	"transports": [
		"L2_BRIDGE"
	],
	"vendor_id": "string"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vmw-nsx-module: ServiceInsertionCommonTypes

[{"label":"Latest (v1.0)","version":"latest"}]

nsx-vmc-policy

Used By

ServiceDefinition

InlineServiceDefinition1

Properties

JSON Example

Vendor Extensions

Used By

Was this page helpful?