NSX-T Data Center REST API

Update the connectivity global configuration

Request:

Method:

PATCH

URI Path(s):

/policy/api/v1/infra/connectivity-global-config
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/connectivity-global-config

Request Headers:

n/a

Query Parameters:

GlobalInheritedRequestParameters+

Name	Description	Type	Notes
apply_locally	Flag to check reaching NSX+ or LM resource If the user sets apply_locally to GET/PUT/PATCH call then the local resource copy will be shown/modified. This will only be acceptable on LM. In case LM only has it's copy, the apply_local = false will still have effect on local copy.	boolean	Default: "False"

Request Body:

GlobalConfig+

GlobalConfig (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
allow_changing_vdr_mac_in_use	A flag to indicate if changing the VDR MAC being used is allowed When this flag is set to true, it is allowed to change the VDR MAC being used by existing transport nodes in a NSX system. The VDR MAC used by a host switch in a transport node is decided by the OVERLAY transport zone(s) which the host switch joins. If any of the OVERLAY transport zone(s) has "nested_nsx" property set to true, the MAC in "vdr_mac_nested" is used; otherwise the MAC in "vdr_mac" is used. Thus the VDR MAC being used by a host switch in a transport node can be changed in below ways. If the host switch is not in any OVERLAY transport zone whose "nested_nsx" property is true but is in an OVERLAY transport zone, the first way is updating the "vdr_mac" property. The 2nd way is updating one of the OVERLAY transport zones joined by the host switch to set "nested_nsx" property true which will make the host switch use the VDR MAC in "vdr_mac_nested". The third way is directly updating the transport node to add an OVERLAY transport zone whose "nested_nsx" property is true into the host switch which will also make the host switch use the VDR MAC in "vdr_mac_nested". If the host switch is in some OVERLAY transport zone(s) whose "nested_nsx" property is true, the first way is updating the "vdr_mac_nested" property. The 2nd way is updating all those OVERLAY transport zones to set "nested_nsx" property false which will make the host switch use the VDR MAC in "vdr_mac". The third way is directly updating the transport node to remove all those OVERLAY transport zones from the host switch which will also make the host switch use the VDR MAC in "vdr_mac". Please note that changing the VDR MAC being used by existing transport nodes will most likely cause traffic disruption and network outage!	boolean	Default: "False"
arp_limit_per_gateway	ARP limit per Tier0/Tier1 gateway Global configuration of maximum number of ARP entries per transport node at each Tier0/Tier1 gateway.	int	Minimum: 5000 Maximum: 50000 Default: "50000"
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
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
external_gateway_bfd	External Bidirectional Flow Detection configuration Configuration for BFD session between host nodes and external gateways. If this configuration is not provided, system defaults are applied.	ExternalGatewayBfdConfig
fips	FIPS enabled config Contains the FIPSGlobalConfig object.	FIPSGlobalConfig
global_replication_mode_enabled	A flag to indicate if global replication mode is enabled When this flag is set true, certain types of BUM packets will be sent to all VTEPs in the global VTEP table, ignoring the logical switching span.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
is_inherited	This field indicates whether this is a copy version of GM/NSX+ or not if True, meaning that this is a copy version of GM if False, meaning that this is a local version on LM	boolean
l3_forwarding_mode	L3 forwarding mode Configure forwarding mode for routing. This setting does not restrict configuration for other modes.	string	Enum: IPV4_ONLY, IPV4_AND_IPV6 Default: "IPV4_ONLY"
lb_ecmp	Flag for controlling equal-cost multi-path(ECMP) load balancing. Flag to activate/deactivate ECMP load balancing. By default ECMP load balancing is deactivated.	boolean	Deprecated Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mtu	MTU size Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. This is the global default MTU for all the EXTERNAL (uplink) and SERVICE (CSP) interfaces in the NSX domain. There is no option to override this value at the transport zone level or transport node level.	int	Minimum: 1280
operation_collectors	Operation global collector config This property is a part of OpsGlobalConfig object. Use /infra/ops-global-config instead. The VRNI and WAVE_FRONT collector type can be defined to collect the metric data. The WAVE_FRONT collector type can only be used in VMC mode.	array of GlobalCollectorConfig (Abstract type: pass one of the following concrete types) VrniGlobalCollector WaveFrontGlobalCollector	Deprecated
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
physical_uplink_mtu	MTU for the physical uplinks This is the global default MTU for all the physical uplinks in a NSX domain. This is the default value for the optional uplink profile MTU field. When the MTU value is not specified in the uplink profile, this global value will be used. This value can be overridden by providing a value for the optional MTU field in the uplink profile. Whenever this value is updated, the updated value will only be propagated to the uplinks that don't have the MTU value in their uplink profiles. If this value is not set, the default value of 1700 will be used. The Transport Node state can be monitored to confirm if the updated MTU value has been realized.	int	Default: "1700"
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
remote_tunnel_physical_mtu	The physical MTU for the remote tunnel endpoints This is the global default MTU for all the physical remote tunnel endpoints in an NSX domain. Please consider intersite link MTU minus any external overhead when defining the MTU. If this value is not set, the default value of 1500 will be used.	int	Default: "1700"
resource_type	Must be set to the value GlobalConfig	string
site_infos	Collection of Site information Information related to sites applicable for given config.	array of SiteInfo	Maximum items: 16
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tep_group_config	VTEP Group Configuration. Indicates if the TEP Grouping is supported in Transport Nodes.	TepGroupConfig
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
uplink_mtu_threshold	Upper threshold for MTU on physical and logical uplinks This value defines the upper threshold for the Maximum Transmission Unit (MTU) value that can be configured at a physical uplink level or a logical routing uplink level in a NSX domain. All Uplink profiles validate against this value so that the MTU specified in an Uplink profile does not exceed this global upper threshold. Similarly, when this value is modified, the new value must be greater than or equal to any existing Uplink profile's MTU.	int	Default: "9000"
vdr_mac	MAC address of the Virtual Distributed Router (VDR) port This is the global default MAC address for all VDRs in all transport nodes in a NSX system. It can be changed only when there is no transport node in the NSX system. This value cannot be same as vdr_mac_nested. When the property "allow_changing_vdr_mac_in_use" is false, it can not be changed if the current VDR MAC is being used by any transport node. A transport node uses this VDR MAC if any host switch in the node is in OVERLAY transport zone(s) but none of the transport zone(s) has "nested_nsx" property being true.	MACAddress	Default: "02:50:56:56:44:52"
vdr_mac_nested	The MAC address of the Virtual Distributed Router (VDR) port in a nested NSX environment. This is the global default MAC address for all VDRs in all transport nodes in a NSX system nested in another NSX system. It can be changed only when there is no transport node in the NSX system. All transport zones in such a nested NSX system will have the "nested_nsx" property being true so that all transport nodes will use this MAC for the VDR ports to avoid conflict with the VDR MAC in the outer NSX system. When the property "allow_changing_vdr_mac_in_use" is false, it can not be changed if the current VDR MAC is being used by any transport node in a nested NSX environment. A transport node uses this VDR MAC if any host switch in the node is in an OVERLAY transport zone whose "nested_nsx" property is true.	MACAddress	Default: "02:50:56:56:44:53"

Example Request:

{ "mtu": 1500, "fips": { "lb_fips_enabled": true, "tls_fips_enabled": false }, "l3_forwarding_mode": "IPV4_AND_IPV6", "uplink_mtu_threshold": 9000, "tep_group_config": { "enable_tep_grouping_on_edge": true }, "global_replication_mode_enabled": false }

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Example Response:

{ "mtu": 1500, "fips": { "lb_fips_enabled": true, "tls_fips_enabled": false }, "l3_forwarding_mode": "IPV4_AND_IPV6", "uplink_mtu_threshold": 9000, "vdr_mac": "02:50:56:56:44:52", "vdr_mac_nested": "02:50:56:56:44:53", "allow_changing_vdr_mac_in_use": false, "arp_limit_per_gateway": 50000, "external_gateway_bfd": { "bfd_profile_path": "/infra/bfd-profiles/default-external-gw-bfd-profile", "enable": true }, "lb_ecmp": false, "remote_tunnel_physical_mtu": 1700, "physical_uplink_mtu": 1700, "global_replication_mode_enabled": false, "tep_group_config": { "enable_tep_grouping_on_edge": true }, "resource_type": "GlobalConfig", "id": "global-config", "display_name": "default", "path": "/infra/global-config", "relative_path": "global-config", "parent_path": "/infra", "remote_path": "", "unique_id": "3dd156ac-bb8b-47c6-850e-3a19f5522bf8", "realization_id": "3dd156ac-bb8b-47c6-850e-3a19f5522bf8", "owner_id": "a3b8ea94-a2ba-4427-8f18-2e29159f6754", "origin_site_id": "a3b8ea94-a2ba-4427-8f18-2e29159f6754", "marked_for_delete": false, "overridden": false, "_system_owned": true, "_create_time": 1669130975078, "_create_user": "system", "_last_modified_time": 1669132569827, "_last_modified_user": "admin", "_revision": 1 }

NSX-T Data Center REST API

Update the connectivity global configuration

Request:

GlobalInheritedRequestParameters (schema)

GlobalConfig (schema)

Example Request:

Successful Response:

Example Response:

Required Permissions:

Feature:

Additional Errors: