ServiceDefinition

Registering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.

Properties

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
optional	_revision	integer	The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	attachment_point	array of string	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.
optional	description	string	Description of this resource
optional	display_name	string	Defaults to ID if not set
optional	functionalities	array of string	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)
optional	id	string	Unique identifier of this resource
optional	implementations	array of string	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.
optional	on_failure_policy	string	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.
optional	resource_type	string	The type of this resource.
optional	service_capability	ServiceCapability	Service capability.
optional	service_deployment_spec	ServiceDeploymentSpec	Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm.
optional	service_manager_id	string	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.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user
optional	transports	array of string	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.
optional	vendor_id	string	Id which is unique to a vendor or partner for which the service is created.

Property of

ServiceInsertionServiceListResult

Parameter To

Create Service Definition
Update Service Definition

Returned By

Create Service Definition
Get Service Definition
Update Service Definition
Get Partner Service

Extends

ManagedResource