com.vmware.nsx_policy.model

Class GlobalConfig.Builder

java.lang.Object

com.vmware.nsx_policy.model.GlobalConfig.Builder

Enclosing class:

GlobalConfig

public static final class GlobalConfig.Builder
extends java.lang.Object

Builder class for GlobalConfig.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of GlobalConfig.

Method Summary

Modifier and Type	Method and Description
GlobalConfig	build()
GlobalConfig.Builder	setAllowChangingVdrMacInUse(java.lang.Boolean allowChangingVdrMacInUse) 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.
GlobalConfig.Builder	setArpLimitPerGateway(java.lang.Long arpLimitPerGateway) Global configuration of maximum number of ARP entries per transport node at each Tier0/Tier1 gateway.
GlobalConfig.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
GlobalConfig.Builder	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setDescription(java.lang.String description) Description of this resource
GlobalConfig.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
GlobalConfig.Builder	setExternalGatewayBfd(ExternalGatewayBfdConfig externalGatewayBfd)
GlobalConfig.Builder	setFips(FIPSGlobalConfig fips)
GlobalConfig.Builder	setGlobalReplicationModeEnabled(java.lang.Boolean globalReplicationModeEnabled) 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.
GlobalConfig.Builder	setId(java.lang.String id) Unique identifier of this resource
GlobalConfig.Builder	setIsInherited(java.lang.Boolean isInherited) if True, meaning that this is a copy version of GM if False, meaning that this is a local version on LM
GlobalConfig.Builder	setL3ForwardingMode(java.lang.String l3ForwardingMode) Possible values are: GlobalConfig.L3FORWARDING_MODE_ONLY GlobalConfig.L3FORWARDING_MODE_AND_IPV6 Configure forwarding mode for routing.
GlobalConfig.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setLbEcmp(java.lang.Boolean lbEcmp) Flag to activate/deactivate ECMP load balancing.
GlobalConfig.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
GlobalConfig.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
GlobalConfig.Builder	setMtu(java.lang.Long mtu) Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.
GlobalConfig.Builder	setOperationCollectors(java.util.List<com.vmware.vapi.bindings.Structure> operationCollectors) This property is a part of OpsGlobalConfig object.
GlobalConfig.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
GlobalConfig.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
GlobalConfig.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
GlobalConfig.Builder	setParentPath(java.lang.String parentPath) Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setPath(java.lang.String path) Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setPhysicalUplinkMtu(java.lang.Long physicalUplinkMtu) This is the global default MTU for all the physical uplinks in a NSX domain.
GlobalConfig.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
GlobalConfig.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
GlobalConfig.Builder	setRelativePath(java.lang.String relativePath) Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
GlobalConfig.Builder	setRemoteTunnelPhysicalMtu(java.lang.Long remoteTunnelPhysicalMtu) This is the global default MTU for all the physical remote tunnel endpoints in an NSX domain.
GlobalConfig.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
GlobalConfig.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
GlobalConfig.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setSelf(SelfResourceLink self)
GlobalConfig.Builder	setSiteInfos(java.util.List<SiteInfo> siteInfos) Information related to sites applicable for given config.
GlobalConfig.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
GlobalConfig.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
GlobalConfig.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
GlobalConfig.Builder	setUplinkMtuThreshold(java.lang.Long uplinkMtuThreshold) 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.
GlobalConfig.Builder	setVdrMac(java.lang.String vdrMac) This is the global default MAC address for all VDRs in all transport nodes in a NSX system.
GlobalConfig.Builder	setVdrMacNested(java.lang.String vdrMacNested) This is the global default MAC address for all VDRs in all transport nodes in a NSX system nested in another NSX system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of GlobalConfig.

Method Detail

setLinks

public GlobalConfig.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public GlobalConfig.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public GlobalConfig.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public GlobalConfig.Builder setRevision(java.lang.Long revision)

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. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public GlobalConfig.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public GlobalConfig.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public GlobalConfig.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public GlobalConfig.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public GlobalConfig.Builder setProtection(java.lang.String protection)

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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public GlobalConfig.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public GlobalConfig.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public GlobalConfig.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public GlobalConfig.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public GlobalConfig.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public GlobalConfig.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public GlobalConfig.Builder setOriginSiteId(java.lang.String originSiteId)

This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

originSiteId - New value for the property.

setOwnerId

public GlobalConfig.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

ownerId - New value for the property.

setParentPath

public GlobalConfig.Builder setParentPath(java.lang.String parentPath)

Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

parentPath - New value for the property.

setPath

public GlobalConfig.Builder setPath(java.lang.String path)

Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

path - New value for the property.

setRealizationId

public GlobalConfig.Builder setRealizationId(java.lang.String realizationId)

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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

realizationId - New value for the property.

setRelativePath

public GlobalConfig.Builder setRelativePath(java.lang.String relativePath)

Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

relativePath - New value for the property.

setRemotePath

public GlobalConfig.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

remotePath - New value for the property.

setUniqueId

public GlobalConfig.Builder setUniqueId(java.lang.String uniqueId)

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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

uniqueId - New value for the property.

setChildren

public GlobalConfig.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)

Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.

Parameters:

children - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

setMarkedForDelete

public GlobalConfig.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)

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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

markedForDelete - New value for the property.

setOverridden

public GlobalConfig.Builder setOverridden(java.lang.Boolean overridden)

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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

overridden - New value for the property.

setAllowChangingVdrMacInUse

public GlobalConfig.Builder setAllowChangingVdrMacInUse(java.lang.Boolean allowChangingVdrMacInUse)

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!

Parameters:

allowChangingVdrMacInUse - New value for the property.

setArpLimitPerGateway

public GlobalConfig.Builder setArpLimitPerGateway(java.lang.Long arpLimitPerGateway)

Global configuration of maximum number of ARP entries per transport node at each Tier0/Tier1 gateway. format: int32

Parameters:

arpLimitPerGateway - New value for the property.

setExternalGatewayBfd

public GlobalConfig.Builder setExternalGatewayBfd(ExternalGatewayBfdConfig externalGatewayBfd)

Parameters:

externalGatewayBfd - New value for the property.

setFips

public GlobalConfig.Builder setFips(FIPSGlobalConfig fips)

Parameters:

fips - New value for the property.

setGlobalReplicationModeEnabled

public GlobalConfig.Builder setGlobalReplicationModeEnabled(java.lang.Boolean globalReplicationModeEnabled)

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.

Parameters:

globalReplicationModeEnabled - New value for the property.

setIsInherited

public GlobalConfig.Builder setIsInherited(java.lang.Boolean isInherited)

if True, meaning that this is a copy version of GM if False, meaning that this is a local version on LM

Parameters:

isInherited - New value for the property.

setL3ForwardingMode

public GlobalConfig.Builder setL3ForwardingMode(java.lang.String l3ForwardingMode)

Possible values are:

• GlobalConfig.L3FORWARDING_MODE_ONLY
• GlobalConfig.L3FORWARDING_MODE_AND_IPV6

Configure forwarding mode for routing. This setting does not restrict configuration for other modes.

Parameters:

l3ForwardingMode - New value for the property.

setLbEcmp

public GlobalConfig.Builder setLbEcmp(java.lang.Boolean lbEcmp)

Flag to activate/deactivate ECMP load balancing. By default ECMP load balancing is deactivated.

Parameters:

lbEcmp - New value for the property.

setMtu

public GlobalConfig.Builder setMtu(java.lang.Long mtu)

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. format: int32

Parameters:

mtu - New value for the property.

setOperationCollectors

public GlobalConfig.Builder setOperationCollectors(java.util.List<com.vmware.vapi.bindings.Structure> operationCollectors)

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.

Parameters:

operationCollectors - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in GlobalCollectorConfig. When methods return a value of this class as a return value, the property will contain all the properties defined in GlobalCollectorConfig.

setPhysicalUplinkMtu

public GlobalConfig.Builder setPhysicalUplinkMtu(java.lang.Long physicalUplinkMtu)

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. format: int32

Parameters:

physicalUplinkMtu - New value for the property.

setRemoteTunnelPhysicalMtu

public GlobalConfig.Builder setRemoteTunnelPhysicalMtu(java.lang.Long remoteTunnelPhysicalMtu)

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. format: int32

Parameters:

remoteTunnelPhysicalMtu - New value for the property.

setSiteInfos

public GlobalConfig.Builder setSiteInfos(java.util.List<SiteInfo> siteInfos)

Information related to sites applicable for given config.

Parameters:

siteInfos - New value for the property.

setUplinkMtuThreshold

public GlobalConfig.Builder setUplinkMtuThreshold(java.lang.Long uplinkMtuThreshold)

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. format: int32

Parameters:

uplinkMtuThreshold - New value for the property.

setVdrMac

public GlobalConfig.Builder setVdrMac(java.lang.String vdrMac)

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. format: mac-address

Parameters:

vdrMac - New value for the property.

setVdrMacNested

public GlobalConfig.Builder setVdrMacNested(java.lang.String vdrMacNested)

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. format: mac-address

Parameters:

vdrMacNested - New value for the property.

build

public GlobalConfig build()