addresspool.go

//
// SPDX-License-Identifier: BSD-3-Clause
//

package redfish

import (
	"encoding/json"

	"github.com/stmcginnis/gofish/common"
)

// ASNumberRange shall contain the Autonomous System (AS) number range.
type ASNumberRange struct {
	// Lower shall contain the lower Autonomous System (AS) number to be used as part of a range of ASN values.
	Lower string
	// Upper shall contain the upper Autonomous System (AS) number to be used as part of a range of ASN values.
	Upper string
}

// AddressPool shall represent an address pool in a Redfish implementation.
type AddressPool struct {
	common.Entity
	// ODataContext is the odata context.
	ODataContext string `json:"@odata.context"`
	// ODataEtag is the odata etag.
	ODataEtag string `json:"@odata.etag"`
	// ODataType is the odata type.
	ODataType string `json:"@odata.type"`
	// Description provides a description of this resource.
	Description string
	// Ethernet shall contain the Ethernet-related properties for this address pool.
	Ethernet APEthernet
	// GenZ shall contain the Gen-Z related properties for this address pool.
	GenZ APGenZ
	// Status shall contain any status or health properties of the resource.
	Status common.Status
	// endpoints is a colleection of URIs for connected endpoints.
	endpoints []string
	// EndpointsCount is the number of connected endpoints.
	EndpointsCount int
	// zones shall contain an array of links to resources of type Zone that this address pool contains.
	zones []string
	// ZonesCount is the number of zones that this address pool contains.
	ZonesCount int
}

// UnmarshalJSON unmarshals a AddressPool object from the raw JSON.
func (addresspool *AddressPool) UnmarshalJSON(b []byte) error {
	type temp AddressPool
	type linkReference struct {
		// Endpoints shall contain an array of links to resources of type Endpoint that this address pool contains.
		Endpoints common.Links
		// Endpoints@odata.count
		EndpointsCount int `json:"Endpoints@odata.count"`
		// Zones shall contain an array of links to resources of type Zone that this address pool contains.
		Zones common.Links
		// Zones@odata.count
		ZonesCount int `json:"Zones@odata.count"`
	}
	var t struct {
		temp
		Links linkReference
	}

	err := json.Unmarshal(b, &t)
	if err != nil {
		return err
	}

	*addresspool = AddressPool(t.temp)
	addresspool.endpoints = t.Links.Endpoints.ToStrings()
	addresspool.EndpointsCount = t.Links.EndpointsCount
	addresspool.zones = t.Links.Zones.ToStrings()
	addresspool.ZonesCount = t.Links.ZonesCount

	return nil
}

// GetAddressPool will get a AddressPool instance from the service.
func GetAddressPool(c common.Client, uri string) (*AddressPool, error) {
	resp, err := c.Get(uri)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	var addresspool AddressPool
	err = json.NewDecoder(resp.Body).Decode(&addresspool)
	if err != nil {
		return nil, err
	}

	addresspool.SetClient(c)
	return &addresspool, nil
}

// ListReferencedAddressPools gets the collection of AddressPool from
// a provided reference.
func ListReferencedAddressPools(c common.Client, link string) ([]*AddressPool, error) {
	var result []*AddressPool
	if link == "" {
		return result, nil
	}

	type GetResult struct {
		Item  *AddressPool
		Link  string
		Error error
	}

	ch := make(chan GetResult)
	collectionError := common.NewCollectionError()
	get := func(link string) {
		addresspool, err := GetAddressPool(c, link)
		ch <- GetResult{Item: addresspool, Link: link, Error: err}
	}

	go func() {
		err := common.CollectList(get, c, link)
		if err != nil {
			collectionError.Failures[link] = err
		}
		close(ch)
	}()

	for r := range ch {
		if r.Error != nil {
			collectionError.Failures[r.Link] = r.Error
		} else {
			result = append(result, r.Item)
		}
	}

	if collectionError.Empty() {
		return result, nil
	}

	return result, collectionError
}

// Endpoints gets the endpoints connected to this address pool.
func (addresspool *AddressPool) Endpoints() ([]*Endpoint, error) {
	var result []*Endpoint

	collectionError := common.NewCollectionError()
	for _, uri := range addresspool.endpoints {
		endpoint, err := GetEndpoint(addresspool.GetClient(), uri)
		if err != nil {
			collectionError.Failures[uri] = err
		} else {
			result = append(result, endpoint)
		}
	}

	if collectionError.Empty() {
		return result, nil
	}

	return result, collectionError
}

// Zones gets the zones associated with this address pool.
func (addresspool *AddressPool) Zones() ([]*Zone, error) {
	var result []*Zone

	collectionError := common.NewCollectionError()
	for _, uri := range addresspool.zones {
		endpoint, err := GetZone(addresspool.GetClient(), uri)
		if err != nil {
			collectionError.Failures[uri] = err
		} else {
			result = append(result, endpoint)
		}
	}

	if collectionError.Empty() {
		return result, nil
	}

	return result, collectionError
}

// BFDSingleHopOnly shall contain the BFD-related properties for an Ethernet fabric that uses Bidirectional
// Forwarding Detection (BFD) for link fault detection.
type BFDSingleHopOnly struct {
	// DemandModeEnabled shall indicate if Bidirectional Forwarding Detection (BFD) Demand Mode is enabled. In Demand
	// mode, no periodic BFD Control packets will flow in either direction.
	DemandModeEnabled bool
	// DesiredMinTxIntervalMilliseconds shall contain the minimum interval, in milliseconds, that the local system
	// would like to use when transmitting Bidirectional Forwarding Detection (BFD) Control packets, less any jitter
	// applied.
	DesiredMinTxIntervalMilliseconds int
	// KeyChain shall contain the name of the Bidirectional Forwarding Detection (BFD) Key Chain.
	KeyChain string
	// LocalMultiplier shall contain the Bidirectional Forwarding Detection (BFD) multiplier value. A BFD multiplier
	// consists of the number of consecutive BFD packets that shall be missed from a BFD peer before declaring that
	// peer unavailable and informing the higher-layer protocols of the failure.
	LocalMultiplier int
	// MeticulousModeEnabled shall indicate whether the keyed MD5 sequence number is updated with every packet. If
	// 'true', the keyed MD5 sequence number is updated with every packet. If 'false', it is updated periodically.
	MeticulousModeEnabled bool
	// RequiredMinRxIntervalMilliseconds shall contain the Bidirectional Forwarding Detection (BFD) receive value. The
	// BFD receive value determines how frequently (in milliseconds) BFD packets will be expected to be received from
	// BFD peers.
	RequiredMinRxIntervalMilliseconds int
	// SourcePort shall contain the Bidirectional Forwarding Detection (BFD) source port.
	SourcePort int
}

// BGPEvpn shall contain the EVPN-related properties for an Ethernet fabric that uses an IETF-defined Ethernet
// Virtual Private Network (EVPN) based control plane specification based on RFC7432.
type BGPEvpn struct {
	// ARPProxyEnabled shall indicate whether proxy Address Resolution Protocol (ARP) is enabled.
	ARPProxyEnabled bool
	// ARPSupressionEnabled shall indicate whether Address Resolution Protocol (ARP) suppression is enabled.
	ARPSupressionEnabled bool
	// AnycastGatewayIPAddress shall contain the anycast gateway IPv4 address for a host subnet.
	AnycastGatewayIPAddress string
	// AnycastGatewayMACAddress shall contain the anycast gateway MAC address for a host subnet.
	AnycastGatewayMACAddress string
	// ESINumberRange shall contain Ethernet Segment Identifier (ESI) number ranges for allocation in supporting
	// functions such as multihoming.
	ESINumberRange ESINumberRange
	// EVINumberRange shall contain the Ethernet Virtual Private Network (EVPN) Instance number (EVI) range for EVPN-
	// based fabrics.
	EVINumberRange EVINumberRange
	// GatewayIPAddress shall contain the Gateway IPv4 address for a host subnet.
	GatewayIPAddress string
	// GatewayIPAddressRange shall contain the IPv4 address range for gateway nodes on this subnet.
	GatewayIPAddressRange GatewayIPAddressRange
	// NDPProxyEnabled shall indicate whether Network Discovery Protocol (NDP) proxy is enabled.
	NDPProxyEnabled bool
	// NDPSupressionEnabled shall indicate whether Network Discovery Protocol (NDP) suppression is enabled.
	NDPSupressionEnabled bool
	// RouteDistinguisherAdministratorSubfield shall contain the RFC4364-defined Route Distinguisher (RD) Administrator
	// subfield.
	RouteDistinguisherAdministratorSubfield string
	// RouteDistinguisherRange shall contain the Route Distinguisher (RD) Instance number range for Ethernet Virtual
	// Private Network (EVPN) based fabrics.
	RouteDistinguisherRange RouteDistinguisherRange
	// RouteTargetAdministratorSubfield shall contain the RFC4364-defined Route Target (RT) Administrator subfield.
	RouteTargetAdministratorSubfield string
	// RouteTargetRange shall contain the Route Target (RT) Instance number range for Ethernet Virtual Private Network
	// (EVPN) based fabrics.
	RouteTargetRange RouteTargetRange
	// UnderlayMulticastEnabled shall indicate whether multicast is enabled on the Ethernet fabric underlay.
	UnderlayMulticastEnabled bool
	// UnknownUnicastSuppressionEnabled shall indicate whether unknown unicast packets should be suppressed.
	UnknownUnicastSuppressionEnabled bool
	// VLANIdentifierAddressRange shall contain the Virtual LAN (VLAN) tag related address range applicable to this
	// Ethernet fabric or for endpoint host subnets. VLAN tags can be used for the purpose of identifying packets
	// belonging to different networks.
	VLANIdentifierAddressRange VLANIdentifierAddressRange
}

// BGPNeighbor shall contain all Border Gateway Protocol (BGP) neighbor related properties.
type BGPNeighbor struct {
	// Address shall contain the IPv4 address assigned to a Border Gateway Protocol (BGP) neighbor.
	Address string
	// AllowOwnASEnabled shall indicate whether the Autonomous System (AS) of the receiving router is permitted in a
	// Border Gateway Protocol (BGP) update. If 'true', routes should be received and processed even if the router
	// detects its own ASN in the AS-Path. If 'false', they should be dropped.
	AllowOwnASEnabled bool
	// CIDR shall contain the RFC4271-defined Classless Inter-Domain Routing (CIDR) value.
	CIDR string
	// ConnectRetrySeconds shall contain the Border Gateway Protocol (BGP) Retry Timer. The BGP Retry Timer allows the
	// administrator to set the amount of time in seconds between retries to establish a connection to configured peers
	// that have gone down.
	ConnectRetrySeconds int
	// Enabled shall indicate whether BGP neighbor communication is enabled.
	Enabled string
	// HoldTimeSeconds shall contain the Border Gateway Protocol (BGP) Hold Timer agreed upon between peers.
	HoldTimeSeconds int
	// KeepaliveIntervalSeconds shall contain the Keepalive timer in seconds. It is used in conjunction with the Border
	// Gateway Protocol (BGP) hold timer.
	KeepaliveIntervalSeconds int
	// LocalAS shall contain the Autonomous System (AS) number of the local Border Gateway Protocol (BGP) peer.
	LocalAS int
	// LogStateChangesEnabled shall indicate whether Border Gateway Protocol (BGP) neighbor state changes are logged.
	LogStateChangesEnabled bool
	// MaxPrefix These properties are applicable to configuring Border Gateway Protocol (BGP) max prefix related
	// properties.
	MaxPrefix MaxPrefix
	// MinimumAdvertisementIntervalSeconds shall contain the minimum time between Border Gateway Protocol (BGP) route
	// advertisements in seconds.
	MinimumAdvertisementIntervalSeconds int
	// PassiveModeEnabled shall indicate whether Border Gateway Protocol (BGP) passive mode is enabled.
	PassiveModeEnabled bool
	// PathMTUDiscoveryEnabled shall indicate whether MTU discovery is permitted.
	PathMTUDiscoveryEnabled bool
	// PeerAS shall contain the Autonomous System (AS) number of the external Border Gateway Protocol (BGP) peer.
	PeerAS int
	// ReplacePeerASEnabled shall indicate whether peer Autonomous System (AS) numbers should be replaced. If 'true',
	// private ASNs are removed and replaced with the peer AS. If 'false', they remain unchanged.
	ReplacePeerASEnabled bool
	// TCPMaxSegmentSizeBytes shall contain the TCP max segment size in bytes signifying the number of bytes that shall
	// be transported in a single packet.
	TCPMaxSegmentSizeBytes int
	// TreatAsWithdrawEnabled shall indicate Border Gateway Protocol (BGP) withdraw status. If 'true', the UPDATE
	// message containing the path attribute shall be treated as though all contained routes had been withdrawn. If
	// 'false', they should remain.
	TreatAsWithdrawEnabled bool
}

// BGPRoute shall contain properties that are applicable to configuring Border Gateway Protocol (BGP) route related
// properties.
type BGPRoute struct {
	// AdvertiseInactiveRoutesEnabled shall indicate whether inactive routes should be advertised. If 'true', advertise
	// the best Border Gateway Protocol (BGP) route that is inactive because of Interior Gateway Protocol (IGP)
	// preference. If 'false', do not use as part of BGP best path selection.
	AdvertiseInactiveRoutesEnabled bool
	// DistanceExternal shall modify the administrative distance for routes learned via External BGP (eBGP).
	DistanceExternal int
	// DistanceInternal shall modify the administrative distance for routes learned via Internal BGP (iBGP).
	DistanceInternal int
	// DistanceLocal shall modify the administrative distance for routes configured on a local router.
	DistanceLocal int
	// ExternalCompareRouterIdEnabled shall indicate whether external router identifiers should be compared. If 'true',
	// prefer the route that comes from the Border Gateway Protocol (BGP) router with the lowest router identifier. If
	// 'false', do not use as part of BGP best path selection.
	ExternalCompareRouterIDEnabled bool `json:"ExternalCompareRouterIdEnabled"`
	// FlapDampingEnabled shall indicate whether route flap dampening should be enabled.
	FlapDampingEnabled bool
	// SendDefaultRouteEnabled shall indicate whether the default route should be advertised. If 'true', the default
	// route is advertised to all Border Gateway Protocol (BGP) neighbors unless specifically denied. If 'false', the
	// default route is not advertised.
	SendDefaultRouteEnabled bool
}

// CommonBGPProperties shall contain properties shared across both External and Internal Border Gateway Protocol
// (BGP) related properties.
type CommonBGPProperties struct {
	// ASNumberRange shall contain the range of Autonomous System (AS) numbers assigned to each Border Gateway Protocol
	// (BGP) peer within the fabric.
	ASNumberRange ASNumberRange
	// BGPNeighbor shall contain all Border Gateway Protocol (BGP) neighbor related properties.
	BGPNeighbor BGPNeighbor
	// BGPRoute shall contain Border Gateway Protocol (BGP) route-related properties.
	BGPRoute BGPRoute
	// GracefulRestart shall contain all graceful restart related properties.
	GracefulRestart GracefulRestart
	// MultiplePaths shall contain all multiple path related properties.
	MultiplePaths MultiplePaths
	// SendCommunityEnabled shall indicate whether community attributes are sent to BGP neighbors.
	SendCommunityEnabled bool
}

// DHCP shall contain settings for assigning DHCP-related properties to the Ethernet fabric.
type DHCP struct {
	// DHCPInterfaceMTUBytes shall contain the Maximum Transmission Unit (MTU) to use on this interface in bytes.
	DHCPInterfaceMTUBytes int
	// DHCPRelayEnabled shall indicate whether Dynamic Host Configuration Protocol (DHCP) Relay is enabled.
	DHCPRelayEnabled bool
	// DHCPServer shall contain an array of addresses assigned to the Dynamic Host Configuration Protocol (DHCP) server
	// for this Ethernet fabric.
	DHCPServer []string
}

// EBGP shall contain the External BGP (eBGP) related properties for an Ethernet fabric.
type EBGP struct {
	// ASNumberRange shall contain the range of Autonomous System (AS) numbers assigned to each Border Gateway Protocol
	// (BGP) peer within the fabric.
	ASNumberRange ASNumberRange
	// AllowDuplicateASEnabled shall indicate whether duplicate Autonomous System (AS) numbers are allowed. If 'true',
	// routes with the same AS number as the receiving router should be allowed. If 'false', routes should be dropped
	// if the router receives its own AS number in a Border Gateway Protocol (BGP) update.
	AllowDuplicateASEnabled bool
	// AllowOverrideASEnabled shall indicate whether Autonomous System (AS) numbers should be overridden. If 'true', AS
	// number should be overridden with the AS number of the sending peer. If 'false', AS number override is disabled.
	AllowOverrideASEnabled bool
	// AlwaysCompareMEDEnabled shall indicate whether neighbor Multi Exit Discriminator (MED) attributes should be
	// compared.
	AlwaysCompareMEDEnabled bool
	// BGPLocalPreference shall contain the local preference value. Highest local preference value is preferred for
	// Border Gateway Protocol (BGP) best path selection.
	BGPLocalPreference int
	// BGPNeighbor shall contain all Border Gateway Protocol (BGP) neighbor related properties.
	BGPNeighbor BGPNeighbor
	// BGPRoute shall contain Border Gateway Protocol (BGP) route-related properties.
	BGPRoute BGPRoute
	// BGPWeight shall contain the Border Gateway Protocol (BGP) weight attribute value for external peers. A higher
	// BGP weight value is preferred for BGP best path selection.
	BGPWeight int
	// GracefulRestart shall contain all graceful restart related properties.
	GracefulRestart GracefulRestart
	// MED shall contain the Border Gateway Protocol (BGP) Multi Exit Discriminator (MED) value. A lower MED value is
	// preferred for BGP best path selection.
	MED int
	// MultihopEnabled shall indicate whether External BGP (eBGP) multihop is enabled.
	MultihopEnabled bool
	// MultihopTTL shall contain the External BGP (eBGP) multihop Time to Live (TTL) value.
	MultihopTTL int
	// MultiplePaths shall contain all multiple path related properties.
	MultiplePaths MultiplePaths
	// SendCommunityEnabled shall indicate whether community attributes are sent to BGP neighbors.
	SendCommunityEnabled bool
}

// ESINumberRange shall contain Ethernet Segment Identifier (ESI) number ranges for allocation in supporting
// functions such as multihoming.
type ESINumberRange struct {
	// Lower shall contain the lower Ethernet Segment Identifier (ESI) number to be used as part of a range of ESI
	// numbers.
	Lower string
	// Upper shall contain the upper Ethernet Segment Identifier (ESI) number to be used as part of a range of ESI
	// numbers.
	Upper string
}

// EVINumberRange shall contain the Ethernet Virtual Private Network (EVPN) Instance (EVI) number range for EVPN-
// based fabrics.
type EVINumberRange struct {
	// Lower shall contain the lower Ethernet Virtual Private Network (EVPN) Instance (EVI) number to be used as part
	// of a range of EVI numbers.
	Lower string
	// Upper shall contain the upper Ethernet Virtual Private Network (EVPN) Instance (EVI) number to be used as part
	// of a range of EVI numbers.
	Upper string
}

// APEthernet shall contain the Ethernet-related properties for an address pool.
type APEthernet struct {
	// BFDSingleHopOnly shall contain the Bidirectional Forwarding Detection (BFD) related properties for this Ethernet
	// fabric.
	BFDSingleHopOnly BFDSingleHopOnly
	// BGPEvpn shall contain the BGP Ethernet Virtual Private Network (EVPN) related properties for this Ethernet
	// fabric.
	BGPEvpn BGPEvpn
	// EBGP shall contain the External BGP (eBGP) related properties for this Ethernet fabric.
	EBGP EBGP
	// IPv4 shall contain IPv4 and Virtual LAN (VLAN) addressing-related properties for this Ethernet fabric.
	IPv4 IPv4
	// MultiProtocolEBGP shall contain the Multi Protocol eBGP (MP eBGP) related properties for this Ethernet fabric.
	MultiProtocolEBGP EBGP
	// MultiProtocolIBGP shall contain the Multi Protocol iBGP (MP iBGP) related properties for this Ethernet fabric.
	MultiProtocolIBGP CommonBGPProperties
}

// GatewayIPAddressRange shall contain the IPv4 address range for gateway nodes for Ethernet Virtual Private
// Network (EVPN) based fabrics.
type GatewayIPAddressRange struct {
	// Lower shall contain the lower IP address to be used as part of a range of addresses for gateway nodes in
	// Ethernet Virtual Private Network (EVPN) based fabrics.
	Lower string
	// Upper shall contain the upper IP address to be used as part of a range of addresses for gateway nodes in
	// Ethernet Virtual Private Network (EVPN) based fabrics.
	Upper string
}

// APGenZ shall contain Gen-Z related properties for an address pool.
type APGenZ struct {
	// AccessKey shall contain the Gen-Z Core Specification-defined Access Key required for this address pool.
	AccessKey string
	// MaxCID shall contain the maximum value for the Gen-Z Core Specification-defined Component Identifier (CID).
	MaxCID int
	// MaxSID shall contain the maximum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).
	MaxSID int
	// MinCID shall contain the minimum value for the Gen-Z Core Specification-defined Component Identifier (CID).
	MinCID int
	// MinSID shall contain the minimum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).
	MinSID int
}

// GracefulRestart shall contain properties that are applicable to configuring Border Gateway Protocol (BGP)
// graceful restart related properties.
type GracefulRestart struct {
	// GracefulRestartEnabled shall indicate whether to enable Border Gateway Protocol (BGP) graceful restart features.
	GracefulRestartEnabled bool
	// HelperModeEnabled shall indicate what to do with stale routes. If 'true', the router continues to be forward
	// packets to stale routes. If 'false', it does not forward packets to stale routes.
	HelperModeEnabled bool
	// StaleRoutesTimeSeconds shall contain the time in seconds to hold stale routes for a restarting peer.
	StaleRoutesTimeSeconds int
	// TimeSeconds shall contain the time in seconds to wait for a graceful restart capable neighbor to re-establish
	// Border Gateway Protocol (BGP) peering.
	TimeSeconds int
}

// IPv4 shall contain IPv4 and Virtual LAN (VLAN) addressing-related properties for an Ethernet fabric.
type IPv4 struct {
	// AnycastGatewayIPAddress shall contain the anycast gateway IPv4 address for a host subnet.
	AnycastGatewayIPAddress string
	// AnycastGatewayMACAddress shall contain the anycast gateway MAC address for a host subnet.
	AnycastGatewayMACAddress string
	// DHCP shall contain the primary and secondary Dynamic Host Configuration Protocol (DHCP) server addressing for
	// this Ethernet fabric.
	DHCP DHCP
	// DNSDomainName shall contain the Domain Name Service (DNS) domain name for this Ethernet fabric.
	DNSDomainName string
	// DNSServer shall contain an array of the Domain Name Service (DNS) servers for this Ethernet fabric.
	DNSServer []string
	// DistributeIntoUnderlayEnabled shall indicate whether host subnets are distributed into the fabric underlay.
	DistributeIntoUnderlayEnabled bool
	// EBGPAddressRange shall contain the range of IPv4 addresses assigned to External BGP (eBGP) neighbors belonging
	// to different ASes (Autonomous Systems).
	EBGPAddressRange IPv4AddressRange
	// FabricLinkAddressRange shall contain link-related IPv4 addressing for this Ethernet fabric typically applied to
	// connections between spine and leaf Ethernet switches.
	FabricLinkAddressRange IPv4AddressRange
	// GatewayIPAddress shall contain the gateway IPv4 address for a host subnet.
	GatewayIPAddress string
	// HostAddressRange shall contain the IP subnet range for host addressing for physical device endpoints that
	// connect to this Ethernet fabric. An endpoint shall be allocated an IP address from this host address range. The
	// Ethernet fabric should provide IP unicast or multicast connectivity for host device endpoints belonging to this
	// host address range.
	HostAddressRange IPv4AddressRange
	// IBGPAddressRange shall contain the range of IPv4 addresses assigned to Internal BGP (iBGP) neighbors belonging
	// to the same AS (Autonomous System).
	IBGPAddressRange IPv4AddressRange
	// LoopbackAddressRange shall contain the range of loopback-related IPv4 addresses assigned to this Ethernet
	// fabric's Ethernet switches. A loopback interface provides a stable interface to which an IP address is then
	// assigned. This address can be configured as the source address when the networking device needs to send data for
	// control-plane protocols such as BGP and OSPF.
	LoopbackAddressRange IPv4AddressRange
	// ManagementAddressRange shall contain the range of management IPv4 addresses assigned to manage this Ethernet
	// fabric's Ethernet switches.
	ManagementAddressRange IPv4AddressRange
	// NTPOffsetHoursMinutes shall contain the Network Time Protocol (NTP) offset. The NTP offset property is used to
	// calculate the time from UTC (Universal Time Coordinated) time in hours and minutes.
	NTPOffsetHoursMinutes int
	// NTPServer shall contain an array of the Network Time Protocol (NTP) servers for this Ethernet fabric.
	NTPServer []string
	// NTPTimezone shall contain the Network Time Protocol (NTP) time zone name assigned to this Ethernet fabric.
	NTPTimezone string
	// NativeVLAN shall contain the Virtual LAN (VLAN) ID value for untagged traffic.
	NativeVLAN int
	// SystemMACRange shall contain the Media Access Control (MAC) address range for systems in Ethernet Virtual
	// Private Network (EVPN) based fabrics.
	SystemMACRange SystemMACRange
	// VLANIdentifierAddressRange shall contain Virtual LAN (VLAN) tags for the entire fabric as well as to end hosts.
	VLANIdentifierAddressRange VLANIdentifierAddressRange
}

// IPv4AddressRange shall contain an IPv4-related address range for an Ethernet fabric.
type IPv4AddressRange struct {
	// Lower shall contain the lower IPv4 network address to be used as part of a subnet.
	Lower string
	// Upper shall contain the upper IPv4 network address to be used as part of a host subnet.
	Upper string
}

// MaxPrefix shall contain properties that are applicable to configuring Border Gateway Protocol (BGP) max prefix
// related properties.
type MaxPrefix struct {
	// MaxPrefixNumber shall contain the maximum number of prefixes allowed from the neighbor.
	MaxPrefixNumber int
	// RestartTimerSeconds This property determines how long peer routers will wait to delete stale routes before a
	// Border Gateway Protocol (BGP) open message is received. This timer should be less than the BGP HoldTimeSeconds
	// property.
	RestartTimerSeconds int
	// ShutdownThresholdPercentage shall contain the percentage of the maximum prefix received value, '1' to '100', at
	// which the router starts to generate a warning message.
	ShutdownThresholdPercentage float64
	// ThresholdWarningOnlyEnabled shall indicate what action to take if the Border Gateway Protocol (BGP) route
	// threshold is reached. If 'true', when the Maximum-Prefix limit is exceeded, a log message is generated. If
	// 'false', when the Maximum-Prefix limit is exceeded, the peer session is terminated.
	ThresholdWarningOnlyEnabled bool
}

// MultiplePaths shall contain properties that are applicable to configuring Border Gateway Protocol (BGP) multiple
// path related properties.
type MultiplePaths struct {
	// MaximumPaths shall contain the maximum number of paths for multiple path operation.
	MaximumPaths int
	// UseMultiplePathsEnabled shall indicate whether multiple paths should be advertised. If 'true', Border Gateway
	// Protocol (BGP) advertises multiple paths for the same prefix for path diversity. If 'false', it advertises based
	// on best path selection.
	UseMultiplePathsEnabled bool
}

// RouteDistinguisherRange shall contain the Route Distinguisher (RD) Instance number range for Ethernet Virtual
// Private Network (EVPN) based fabrics.
type RouteDistinguisherRange struct {
	// Lower shall contain the lower Route Distinguisher (RD) number to be used as part of a range of Route
	// Distinguisher values.
	Lower string
	// Upper shall contain the upper Route Distinguisher (RD) number to be used as part of a range of Route
	// Distinguisher values.
	Upper string
}

// RouteTargetRange shall contain the Route Target (RT) Instance number range for Ethernet Virtual Private Network
// (EVPN) based fabrics.
type RouteTargetRange struct {
	// Lower shall contain the lower Route Target (RT) number to be used as part of a range of Route Target values.
	Lower int
	// Upper shall contain the upper Route Target (RT) number to be used as part of a range of Route Target values.
	Upper int
}

// SystemMACRange shall contain the Media Access Control (MAC) address range for Ethernet Virtual Private Network
// (EVPN) based fabrics.
type SystemMACRange struct {
	// Lower shall contain the lower system Media Access Control (MAC) address to be used as part of a range of system
	// MAC addresses.
	Lower string
	// Upper shall contain the upper system Media Access Control (MAC) address to be used as part of a range of system
	// MAC addresses.
	Upper string
}

// VLANIdentifierAddressRange shall contain settings for assigning Virtual LAN (VLAN) tags for the entire fabric as
// well as for end hosts.
type VLANIdentifierAddressRange struct {
	// Lower shall contain the Virtual LAN (VLAN) tag lower value.
	Lower int
	// Upper shall contain the Virtual LAN (VLAN) tag upper value.
	Upper int
}