Update an Existing Section, Including Its Rules

Modifies existing serviceinsertion section along with its association with rules.
When invoked on a large number of rules, this API is supported only at low
rates of invocation (not more than 2 times per minute). The typical latency
of this API with about 1024 rules is about 15 seconds in a cluster setup.
This API should not be invoked with large payloads at automation speeds.

Instead, to update rule content, use:
PUT /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>

Request:

Method:

POST

URI Path(s):

/api/v1/serviceinsertion/sections/<section-id>?action=update_with_rules

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ServiceInsertionSectionRuleList+

ServiceInsertionSectionRuleList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
applied_tos	AppliedTo List List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.	array of ResourceReference	Maximum items: 128
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_default	Default section flag It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.	boolean	Readonly
resource_type	Must be set to the value ServiceInsertionSectionRuleList	string
rule_count	Rule count Number of rules in this section.	integer	Readonly
rules	List of the Service Insertion rules List of Service Insertion rules in the section. Only homogeneous rules are supported.	array of ServiceInsertionRule	Required Maximum items: 1000
section_type	Section Type Type of the rules which a section can contain. Only homogeneous sections are supported.	string	Required Enum: LAYER2, LAYER3, L3REDIRECT, IDS
stateful	Stateful nature of the distributed service rules in the section. Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.	boolean	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	TCP Strict Ensures that a three way TCP handshake is done before the data packets are sent if the value is set to be true. tcp_strict=true is supported only for stateful sections.	boolean	Default: "False"

Example Request:

POST https://<nsx-mgr>/api/v1/serviceinsertion/sections/79b29ea5-051a-4ab2-af85-fb6520a9f881?action=update_with_rules { "resource_type": "ServiceInsertionSection", "description": "Section containing Service Insertion Rules", "id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "display_name": "my section", "tags": [], "section_type": "L3REDIRECT", "is_default": false, "stateful": false, "rules": [ { "id": "1639424", "display_name": "my best rule", "notes": "This is my note", "destinations_excluded": false, "redirect_tos": [ { "target_display_name": "serviceinstance-1", "is_valid": true, "target_type": "ServiceInstance", "target_id": "1d9fb5cb-0344-4d7f-899a-afd93276899f" } ], "applied_tos": [ { "target_display_name": "plr1_uplink1", "is_valid": true, "target_type": "LogicalRouterPort", "target_id": "bd91fc7f-cd76-438b-8d4f-21dbdc707af7" } ], "sources": [ { "target_display_name": "192.168.200.2", "is_valid": true, "target_type": "IPv4Address", "target_id": "192.168.200.2" } ], "destinations": [ { "target_display_name": "192.168.200.3", "is_valid": true, "target_type": "IPv4Address", "target_id": "192.168.200.3" } ], "ip_protocol": "IPV4_IPV6", "rule_tag": "", "logged": false, "action": "ALLOW", "sources_excluded": false, "disabled": false, "direction": "IN_OUT" } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceInsertionSectionRuleList+

ServiceInsertionSectionRuleList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
applied_tos	AppliedTo List List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.	array of ResourceReference	Maximum items: 128
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_default	Default section flag It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.	boolean	Readonly
resource_type	Must be set to the value ServiceInsertionSectionRuleList	string
rule_count	Rule count Number of rules in this section.	integer	Readonly
rules	List of the Service Insertion rules List of Service Insertion rules in the section. Only homogeneous rules are supported.	array of ServiceInsertionRule	Required Maximum items: 1000
section_type	Section Type Type of the rules which a section can contain. Only homogeneous sections are supported.	string	Required Enum: LAYER2, LAYER3, L3REDIRECT, IDS
stateful	Stateful nature of the distributed service rules in the section. Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.	boolean	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	TCP Strict Ensures that a three way TCP handshake is done before the data packets are sent if the value is set to be true. tcp_strict=true is supported only for stateful sections.	boolean	Default: "False"

Example Response:

{ "resource_type": "ServiceInsertionSectionRuleList", "description": "Service Insertion Rules List", "id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "display_name": "my section", "tags": [], "section_type": "L3REDIRECT", "is_default": false, "stateful": false, "rule_count": 1, "rules": [ { "id": "1639424", "display_name": "my best rule", "section_id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "notes": "This is my note", "destinations_excluded": false, "redirect_tos": [ { "target_display_name": "serviceinstance-1", "is_valid": true, "target_type": "ServiceInstance", "target_id": "1d9fb5cb-0344-4d7f-899a-afd93276899f" } ], "applied_tos": [ { "target_display_name": "plr1_uplink1", "is_valid": true, "target_type": "LogicalRouterPort", "target_id": "bd91fc7f-cd76-438b-8d4f-21dbdc707af7" } ], "sources": [ { "target_display_name": "192.168.200.2", "is_valid": true, "target_type": "IPv4Address", "target_id": "192.168.200.2" } ], "destinations": [ { "target_display_name": "192.168.200.3", "is_valid": true, "target_type": "IPv4Address", "target_id": "192.168.200.3" } ], "ip_protocol": "IPV4_IPV6", "rule_tag": "", "logged": false, "action": "ALLOW", "sources_excluded": false, "disabled": false, "direction": "IN_OUT", "_revision": 2 } ], "_last_modified_user": "admin", "_last_modified_time": 1446249271991, "_revision": 2 }

Update an Existing Section, Including Its Rules

Request:

ServiceInsertionSectionRuleList (schema)

Example Request:

Successful Response:

ServiceInsertionSectionRuleList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: