NSX-T Data Center REST API
PartialPatchConfig (schema)
Contains configuration for Partial patch.
Basic Concept: Partial Patch is a specialized feature in NSX that allows you to update only a specific part of an
object's properties, instead of updating the entire object. This is particularly useful for making incremental
changes to an object.
Enabling Partial Patch: By default, Partial Patch is disabled. You need to explicitly enable this feature to use it.
When enabled, you can update a subset of an object's fields, merging your new data with the existing object's data.
Usage in API Operations: When Partial Patch is disabled, complete object data is required for both PUT and PATCH
operations in /policy APIs. Once enabled, you can provide only the necessary subset of data for these operations.
Important Considerations:In a partial patch, array properties are entirely replaced, not merged. If a PATCH operation
targets a non-existing object, NSX will create a new object after performing all required validations. Be aware of
fields that depend on each other (like username and password, or IP address and thumbprint). In such cases, either
all or none of these inter-dependent fields should be provided in a Partial Patch request. Partial Patch does not
support certain objects, such as 'Infra'. Objects like Labels, Security Policies, and Services have specific
attributes that are treated differently in PATCH requests. This special handling won't change with Partial Patch.
For example, in Security Policies, adding 'rules' through PATCH merges them with existing rules, while a PUT
operation replaces them entirely. Partial Patch won't work if the new value for a property is of a different
polymorphic type than the existing value.
Name | Description | Type | Notes |
---|---|---|---|
enable_partial_patch | This object will contain the partial patch configuration. boolean value used to activate/deactivate partial patch |
boolean | Required |