3.1.5.16 serviceInsertions

The serviceInsertions resource specifies the relationship between the service insertion and the service insertion rule.

It is invoked through the following URI.

 https://<url>/networking/v1/serviceInsertions/{resourceId}

url: The address or name of the REST server of the Network Controller.

resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method	Section	Description
PUT	3.1.5.16.1.1	Create a new serviceInsertions resource or update an existing serviceInsertions resource.
GET	3.1.5.16.1.2	Get one serviceInsertions resource.
GET ALL	3.1.5.16.1.3	List all serviceInsertions resources in the Network Controller.
DELETE	3.1.5.16.1.4	Deletes a serviceInsertions resource

The following property elements are valid.

Element name	Type	Description
etag	Read-only	Specified in Common JSON Elements, section 2.2.2.
provisioningState	Read-only	Specified in Common JSON Elements, section 2.2.2.
ipConfiguration	Read-only	Indicate references to ipConfigurations resources this access control list is associated with.
priority	Required	Indicates the relative order in which the policies are processed.  Priorities MUST be unique, and a PUT will fail if policies with duplicate priorities are specified.
type	Required	Indicate the type of service insertion. Valid value is PortMirror.
rules	Optional	Indicates an array of rules used to define what traffic will go through the service insertion.
rules.protocol	Optional	Indicates the protocol to match for this rule.  Valid values are Tcp, Udp, Http, or All. The value "All" indicates the rule will match for all protocols.
rules.sourcePortStart	Required	Indicates the starting source port to match.  This value MUST be between 0 and 65535.  Specify 0 to indicate any port.
rules.sourcePortEnd	Optional	Indicates the end of range of source ports to match. This value MUST be greater than the sourcePortStart element.  If not specified, then only the start port is matched.
rules.destinationPortStart	Required	Indicates the starting destination port to match.   This value MUST be between 0 and 65535.  Specify 0 to indicate any port.
rules.destinationPortEnd	Optional	Indicates the end of range of destination ports to match.  This value MUST be greater than the destinationPortStart element.  If not specified, then only the start destination port is matched.
rules.sourceSubnets	Optional	Indicates an array of subnets to match as source subnet.  For a single source IP address match specify as a /32 subnet.
rules.destinationSubnets	Optional	Indicates an array of subnets to match as the destination subnet.  For a single source IP address match specify as a /32 subnet.
serviceInsertionElements	Optional	Indicates an array of elements in the list of network interfaces to send packets matching rules through. If type is PortMirror then the array MUST contain 1 element.
serviceInsertionElements.description	Optional	Indicates the description of the element in the service insertion.
serviceInsertionElements.order	Required	Indicates the position in the service insertion that the element is located.  This value MUST be unique in the serviceInsertions resource.  The lowest value element will be the first element in the insertion.
serviceInsertionElements.name	Optional	User friendly name of the appliance/element.
serviceInsertionElements.networkInterface	Required	Indicates a networkInterfaces resource that is an element in the service insertion.
subnets	Read-only	Indicates an array of references to subnets resources with which this serviceInsertions resource is associated.