com.vmware.nsx_policy.model

Class Tier0.Builder

java.lang.Object

com.vmware.nsx_policy.model.Tier0.Builder

Enclosing class:

Tier0

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

Builder class for Tier0.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Tier0	build()
Tier0.Builder	setAdvancedConfig(Tier0AdvancedConfig advancedConfig)
Tier0.Builder	setArpLimit(java.lang.Long arpLimit) Maximum number of ARP entries per transport node.
Tier0.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
Tier0.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.
Tier0.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.
Tier0.Builder	setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging) Indicates if logging should be enabled for the default whitelisting rule.
Tier0.Builder	setDescription(java.lang.String description) Description of this resource
Tier0.Builder	setDhcpConfigPaths(java.util.List<java.lang.String> dhcpConfigPaths) DHCP configuration for Segments connected to Tier-0.
Tier0.Builder	setDisableFirewall(java.lang.Boolean disableFirewall) Disable or enable gateway fiewall.
Tier0.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
Tier0.Builder	setFailoverMode(java.lang.String failoverMode) Possible values are: Tier0.FAILOVER_MODE_PREEMPTIVE Tier0.FAILOVER_MODE_NON_PREEMPTIVE Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure.
Tier0.Builder	setFederationConfig(FederationGatewayConfig federationConfig)
Tier0.Builder	setForceWhitelisting(java.lang.Boolean forceWhitelisting) This field is deprecated and recommended to change Rule action field.
Tier0.Builder	setHaMode(java.lang.String haMode) Possible values are: Tier0.HA_MODE_ACTIVE Tier0.HA_MODE_STANDBY Specify high-availability mode for Tier-0.
Tier0.Builder	setId(java.lang.String id) Unique identifier of this resource
Tier0.Builder	setInternalTransitSubnets(java.util.List<java.lang.String> internalTransitSubnets) Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers.
Tier0.Builder	setIntersiteConfig(IntersiteGatewayConfig intersiteConfig)
Tier0.Builder	setIpv6ProfilePaths(java.util.List<java.lang.String> ipv6ProfilePaths) IPv6 NDRA and DAD profiles configuration on Tier0.
Tier0.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.
Tier0.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.
Tier0.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
Tier0.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
Tier0.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
Tier0.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
Tier0.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
Tier0.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.
Tier0.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.
Tier0.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.
Tier0.Builder	setRdAdminField(java.lang.String rdAdminField) If you are using EVPN service, then route distinguisher administrator address should be defined if you need auto generation of route distinguisher on your VRF configuration.
Tier0.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
Tier0.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.
Tier0.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.
Tier0.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
Tier0.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
Tier0.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.
Tier0.Builder	setSelf(SelfResourceLink self)
Tier0.Builder	setStatefulServices(Tier0StatefulServicesConfig statefulServices)
Tier0.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.
Tier0.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
Tier0.Builder	setTransitSubnets(java.util.List<java.lang.String> transitSubnets) Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s.
Tier0.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
Tier0.Builder	setVrfConfig(Tier0VrfConfig vrfConfig)
Tier0.Builder	setVrfTransitSubnets(java.util.List<java.lang.String> vrfTransitSubnets) Specify subnets that are used to assign addresses to logical links connecting default T0 and child VRFs.

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 Tier0.

Method Detail

setLinks

public Tier0.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 Tier0.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 Tier0.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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 Tier0.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.

setAdvancedConfig

public Tier0.Builder setAdvancedConfig(Tier0AdvancedConfig advancedConfig)

Parameters:

advancedConfig - New value for the property.

setArpLimit

public Tier0.Builder setArpLimit(java.lang.Long arpLimit)

Maximum number of ARP entries per transport node. format: int32

Parameters:

arpLimit - New value for the property.

setDefaultRuleLogging

public Tier0.Builder setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging)

Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.

Parameters:

defaultRuleLogging - New value for the property.

setDhcpConfigPaths

public Tier0.Builder setDhcpConfigPaths(java.util.List<java.lang.String> dhcpConfigPaths)

DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.

Parameters:

dhcpConfigPaths - New value for the property.

setDisableFirewall

public Tier0.Builder setDisableFirewall(java.lang.Boolean disableFirewall)

Disable or enable gateway fiewall.

Parameters:

disableFirewall - New value for the property.

setFailoverMode

public Tier0.Builder setFailoverMode(java.lang.String failoverMode)

Possible values are:

• Tier0.FAILOVER_MODE_PREEMPTIVE
• Tier0.FAILOVER_MODE_NON_PREEMPTIVE

Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property is not used when the ha_mode property is set to ACTIVE_ACTIVE. Only applicable when edge cluster is configured in Tier0 locale-service.

Parameters:

failoverMode - New value for the property.

setFederationConfig

public Tier0.Builder setFederationConfig(FederationGatewayConfig federationConfig)

Parameters:

federationConfig - New value for the property.

setForceWhitelisting

public Tier0.Builder setForceWhitelisting(java.lang.Boolean forceWhitelisting)

This field is deprecated and recommended to change Rule action field. Note that this field is not synchronized with default rule field.

Parameters:

forceWhitelisting - New value for the property.

setHaMode

public Tier0.Builder setHaMode(java.lang.String haMode)

Possible values are:

• Tier0.HA_MODE_ACTIVE
• Tier0.HA_MODE_STANDBY

Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE. When ha_mode is changed from ACTIVE_ACTIVE to ACTIVE_STANDBY, inter SR iBGP (in BGP) is disabled. Changing ha_mode from ACTIVE_STANDBY to ACTIVE_ACTIVE will enable inter SR iBGP (in BGP) and previously configured preferred edge nodes (in Tier0 locale-service) are removed.

Parameters:

haMode - New value for the property.

setInternalTransitSubnets

public Tier0.Builder setInternalTransitSubnets(java.util.List<java.lang.String> internalTransitSubnets)

Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode. format: ip-cidr-block

Parameters:

internalTransitSubnets - New value for the property.

setIntersiteConfig

public Tier0.Builder setIntersiteConfig(IntersiteGatewayConfig intersiteConfig)

Parameters:

intersiteConfig - New value for the property.

setIpv6ProfilePaths

public Tier0.Builder setIpv6ProfilePaths(java.util.List<java.lang.String> ipv6ProfilePaths)

IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured.

Parameters:

ipv6ProfilePaths - New value for the property.

setRdAdminField

public Tier0.Builder setRdAdminField(java.lang.String rdAdminField)

If you are using EVPN service, then route distinguisher administrator address should be defined if you need auto generation of route distinguisher on your VRF configuration. format: ip

Parameters:

rdAdminField - New value for the property.

setStatefulServices

public Tier0.Builder setStatefulServices(Tier0StatefulServicesConfig statefulServices)

Parameters:

statefulServices - New value for the property.

setTransitSubnets

public Tier0.Builder setTransitSubnets(java.util.List<java.lang.String> transitSubnets)

Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default. When modifying, for stateful active-active Tier-0 number of IPs should be at least attached Tier-1s count * 16 and for other type of Tier-0 number of IPs should be at least attached Tier-1s count * 2. Modification not allowed if there are child tier-0 VRFs and there are any Tier-1s connected to those VRFs. The value in VRF tier-0 is always inherited from the parent. format: ip-cidr-block

Parameters:

transitSubnets - New value for the property.

setVrfConfig

public Tier0.Builder setVrfConfig(Tier0VrfConfig vrfConfig)

Parameters:

vrfConfig - New value for the property.

setVrfTransitSubnets

public Tier0.Builder setVrfTransitSubnets(java.util.List<java.lang.String> vrfTransitSubnets)

Specify subnets that are used to assign addresses to logical links connecting default T0 and child VRFs. When not specified, subnet 169.254.2.0/23 is assigned by default. format: ip-cidr-block

Parameters:

vrfTransitSubnets - New value for the property.

build

public Tier0 build()