InlineServiceDefinition1

JSON Example

{
    "attachment_point": [
        "string"
    ],
    "functionalities": [
        "string"
    ],
    "implementations": [
        "string"
    ],
    "on_failure_policy": "string",
    "service_capability": {
        "can_decrement_si": false,
        "nsh_liveness_support_enabled": false
    },
    "service_deployment_spec": "ServiceDeploymentSpec Object",
    "service_manager_id": "string",
    "transports": [
        "string"
    ],
    "vendor_id": "string"
}

array of string

attachment_point

Optional

Constraints: minItems: 0 maxItems: 2

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 and MPS.

Possible values are : TIER0_LR, TIER1_LR, SERVICE_PLANE,

array of string

functionalities

Required

Constraints: minItems: 1

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 | TLB - Transparent Load Balancer | EPP - Endpoint Protection.(Third party AntiVirus partners using NXGI should use this functionality for the service) | MPS - Malware Prevention Solution

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

array of string

implementations

Required

Constraints: minItems: 1 maxItems: 1

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

on_failure_policy

Optional

Constraints: default: ALLOW

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) and MPS functionality.

Possible values are : ALLOW, BLOCK,

ServiceCapability

service_capability

Optional

Service capabilities that will be inherited by service VMs created using a service definition that contains this service capability.

ServiceDeploymentSpec

service_deployment_spec

Optional

ServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.

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

Constraints: minItems: 0 maxItems: 1

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 and MPS.

Possible values are : L2_BRIDGE, L3_ROUTED, NSH,

string

vendor_id

Required

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

Used By

ServiceDefinition