Package com.softlayer.api.service.network

Class Vlan

  • @ApiType("SoftLayer_Network_Vlan")
public class Vlan
extends Entity
    The SoftLayer_Network_Vlan data type models a single VLAN within SoftLayer's public and private networks. a Virtual LAN is a structure that associates network interfaces on routers, switches, and servers in different locations to act as if they were on the same local network broadcast domain. VLANs are a central part of the SoftLayer network. They can determine how new IP subnets are routed and how individual servers communicate to each other.
    See Also:
    SoftLayer_Network_Vlan

    • Field Detail

      • account

        @ApiProperty
protected Account account
        The SoftLayer customer account associated with a VLAN.

      • additionalPrimarySubnets

        @ApiProperty
protected List<Subnet> additionalPrimarySubnets
        A VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool.

      • attachedNetworkGateway

        @ApiProperty
protected Gateway attachedNetworkGateway
        The gateway this VLAN is inside of.

      • attachedNetworkGatewayFlag

        @ApiProperty
protected Boolean attachedNetworkGatewayFlag
        Whether or not this VLAN is inside a gateway.

      • attachedNetworkGatewayVlan

        @ApiProperty
protected Vlan attachedNetworkGatewayVlan
        The inside VLAN record if this VLAN is inside a network gateway.

      • billingItem

        @ApiProperty
protected Item billingItem
        The billing item for a network vlan.

      • dedicatedFirewallFlag

        @ApiProperty
protected Long dedicatedFirewallFlag
        A flag indicating that a network vlan is on a Hardware Firewall (Dedicated).

      • extensionRouter

        @ApiProperty
protected Router extensionRouter
        The extension router that a VLAN is associated with.

      • firewallGuestNetworkComponents

        @ApiProperty
protected List<Firewall> firewallGuestNetworkComponents
        A firewalled Vlan's network components.

      • firewallInterfaces

        @ApiProperty
protected List<Interface> firewallInterfaces
        A firewalled vlan's inbound/outbound interfaces.

      • firewallNetworkComponents

        @ApiProperty
protected List<Firewall> firewallNetworkComponents
        A firewalled Vlan's network components.

      • firewallRules

        @ApiProperty
protected List<Rule> firewallRules
        The currently running rule set of a firewalled VLAN.

      • guestNetworkComponents

        @ApiProperty
protected List<Component> guestNetworkComponents
        The networking components that are connected to a VLAN.

      • hardware

        @ApiProperty
protected List<Hardware> hardware
        All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.

      • localDiskStorageCapabilityFlag

        @ApiProperty
protected Boolean localDiskStorageCapabilityFlag
        A flag indicating that a vlan can be assigned to a host that has local disk functionality.

      • networkComponentTrunks

        @ApiProperty
protected List<Trunk> networkComponentTrunks
        The network components that are connected to this VLAN through a trunk.

      • networkComponents

        @ApiProperty
protected List<Component> networkComponents
        The networking components that are connected to a VLAN.

      • networkSpace

        @ApiProperty
protected String networkSpace
        Identifier to denote whether a VLAN is used for public or private connectivity.

      • networkVlanFirewall

        @ApiProperty
protected Firewall networkVlanFirewall
        The Hardware Firewall (Dedicated) for a network vlan.

      • primaryRouter

        @ApiProperty
protected Router primaryRouter
        The primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.

      • primarySubnet

        @ApiProperty
protected Subnet primarySubnet
        A VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased.

      • primarySubnetVersion6

        @ApiProperty
protected Subnet primarySubnetVersion6
        A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet.

      • privateNetworkGateways

        @ApiProperty
protected List<Gateway> privateNetworkGateways
        The gateways this VLAN is the private VLAN of.

      • publicNetworkGateways

        @ApiProperty
protected List<Gateway> publicNetworkGateways
        The gateways this VLAN is the public VLAN of.

      • sanStorageCapabilityFlag

        @ApiProperty
protected Boolean sanStorageCapabilityFlag
        A flag indicating that a vlan can be assigned to a host that has SAN disk functionality.

      • scaleVlans

        @ApiProperty
protected List<Vlan> scaleVlans
        Collection of scale VLANs this VLAN applies to.

      • secondaryRouter

        @ApiProperty
protected Hardware secondaryRouter
        The secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.

      • secondarySubnets

        @ApiProperty
protected List<Subnet> secondarySubnets
        The subnets that exist as secondary interfaces on a VLAN

      • totalPrimaryIpAddressCount

        @ApiProperty
protected Long totalPrimaryIpAddressCount
        The number of primary IP addresses in a VLAN.

      • virtualGuests

        @ApiProperty
protected List<Guest> virtualGuests
        All of the Virtual Servers that are connected to a VLAN.

      • accountIdSpecified

        protected boolean accountIdSpecified

      • id

        @ApiProperty(canBeNullOrNotSet=true)
protected Long id
        A VLAN's internal identifier. This should not be confused with the ''vlanNumber'' property, which is used in network configuration.

      • idSpecified

        protected boolean idSpecified

      • modifyDateSpecified

        protected boolean modifyDateSpecified

      • nameSpecified

        protected boolean nameSpecified

      • noteSpecified

        protected boolean noteSpecified

      • primarySubnetIdSpecified

        protected boolean primarySubnetIdSpecified

      • vlanNumber

        @ApiProperty(canBeNullOrNotSet=true)
protected Long vlanNumber
        A VLAN's number as recorded within the SoftLayer network. This is configured directly on SoftLayer's networking equipment and should not be confused with a VLAN's ''id'' property.

      • vlanNumberSpecified

        protected boolean vlanNumberSpecified

      • additionalPrimarySubnetCount

        @ApiProperty
protected Long additionalPrimarySubnetCount
        A count of a VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool.

      • firewallGuestNetworkComponentCount

        @ApiProperty
protected Long firewallGuestNetworkComponentCount
        A count of a firewalled Vlan's network components.

      • firewallInterfaceCount

        @ApiProperty
protected Long firewallInterfaceCount
        A count of a firewalled vlan's inbound/outbound interfaces.

      • firewallNetworkComponentCount

        @ApiProperty
protected Long firewallNetworkComponentCount
        A count of a firewalled Vlan's network components.

      • firewallRuleCount

        @ApiProperty
protected Long firewallRuleCount
        A count of the currently running rule set of a firewalled VLAN.

      • guestNetworkComponentCount

        @ApiProperty
protected Long guestNetworkComponentCount
        A count of the networking components that are connected to a VLAN.

      • hardwareCount

        @ApiProperty
protected Long hardwareCount
        A count of all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.

      • networkComponentCount

        @ApiProperty
protected Long networkComponentCount
        A count of the networking components that are connected to a VLAN.

      • networkComponentTrunkCount

        @ApiProperty
protected Long networkComponentTrunkCount
        A count of the network components that are connected to this VLAN through a trunk.

      • privateNetworkGatewayCount

        @ApiProperty
protected Long privateNetworkGatewayCount
        A count of the gateways this VLAN is the private VLAN of.

      • protectedIpAddressCount

        @ApiProperty
protected Long protectedIpAddressCount
        A count of

      • publicNetworkGatewayCount

        @ApiProperty
protected Long publicNetworkGatewayCount
        A count of the gateways this VLAN is the public VLAN of.

      • scaleVlanCount

        @ApiProperty
protected Long scaleVlanCount
        A count of collection of scale VLANs this VLAN applies to.

      • secondarySubnetCount

        @ApiProperty
protected Long secondarySubnetCount
        A count of the subnets that exist as secondary interfaces on a VLAN

      • subnetCount

        @ApiProperty
protected Long subnetCount
        A count of all of the subnets that exist as VLAN interfaces.

      • tagReferenceCount

        @ApiProperty
protected Long tagReferenceCount
        A count of references to all tags for this VLAN.

      • virtualGuestCount

        @ApiProperty
protected Long virtualGuestCount
        A count of all of the Virtual Servers that are connected to a VLAN.

    • Constructor Detail

      • Vlan

        public Vlan()

    • Method Detail

      • getAccount

        public Account getAccount()

      • setAccount

        public void setAccount​(Account account)

      • getAdditionalPrimarySubnets

        public List<Subnet> getAdditionalPrimarySubnets()

      • getAttachedNetworkGateway

        public Gateway getAttachedNetworkGateway()

      • setAttachedNetworkGateway

        public void setAttachedNetworkGateway​(Gateway attachedNetworkGateway)

      • getAttachedNetworkGatewayFlag

        public Boolean getAttachedNetworkGatewayFlag()

      • setAttachedNetworkGatewayFlag

        public void setAttachedNetworkGatewayFlag​(Boolean attachedNetworkGatewayFlag)

      • getAttachedNetworkGatewayVlan

        public Vlan getAttachedNetworkGatewayVlan()

      • setAttachedNetworkGatewayVlan

        public void setAttachedNetworkGatewayVlan​(Vlan attachedNetworkGatewayVlan)

      • getBillingItem

        public Item getBillingItem()

      • setBillingItem

        public void setBillingItem​(Item billingItem)

      • getDedicatedFirewallFlag

        public Long getDedicatedFirewallFlag()

      • setDedicatedFirewallFlag

        public void setDedicatedFirewallFlag​(Long dedicatedFirewallFlag)

      • getExtensionRouter

        public Router getExtensionRouter()

      • setExtensionRouter

        public void setExtensionRouter​(Router extensionRouter)

      • getFirewallGuestNetworkComponents

        public List<Firewall> getFirewallGuestNetworkComponents()

      • getFirewallInterfaces

        public List<Interface> getFirewallInterfaces()

      • getFirewallNetworkComponents

        public List<Firewall> getFirewallNetworkComponents()

      • getFirewallRules

        public List<Rule> getFirewallRules()

      • getGuestNetworkComponents

        public List<Component> getGuestNetworkComponents()

      • getHighAvailabilityFirewallFlag

        public Boolean getHighAvailabilityFirewallFlag()

      • setHighAvailabilityFirewallFlag

        public void setHighAvailabilityFirewallFlag​(Boolean highAvailabilityFirewallFlag)

      • getLocalDiskStorageCapabilityFlag

        public Boolean getLocalDiskStorageCapabilityFlag()

      • setLocalDiskStorageCapabilityFlag

        public void setLocalDiskStorageCapabilityFlag​(Boolean localDiskStorageCapabilityFlag)

      • getNetwork

        public Network getNetwork()

      • setNetwork

        public void setNetwork​(Network network)

      • getNetworkComponentTrunks

        public List<Trunk> getNetworkComponentTrunks()

      • getNetworkComponents

        public List<Component> getNetworkComponents()

      • getNetworkSpace

        public String getNetworkSpace()

      • setNetworkSpace

        public void setNetworkSpace​(String networkSpace)

      • getNetworkVlanFirewall

        public Firewall getNetworkVlanFirewall()

      • setNetworkVlanFirewall

        public void setNetworkVlanFirewall​(Firewall networkVlanFirewall)

      • getPrimaryRouter

        public Router getPrimaryRouter()

      • setPrimaryRouter

        public void setPrimaryRouter​(Router primaryRouter)

      • getPrimarySubnet

        public Subnet getPrimarySubnet()

      • setPrimarySubnet

        public void setPrimarySubnet​(Subnet primarySubnet)

      • getPrimarySubnetVersion6

        public Subnet getPrimarySubnetVersion6()

      • setPrimarySubnetVersion6

        public void setPrimarySubnetVersion6​(Subnet primarySubnetVersion6)

      • getPrimarySubnets

        public List<Subnet> getPrimarySubnets()

      • getPrivateNetworkGateways

        public List<Gateway> getPrivateNetworkGateways()

      • getProtectedIpAddresses

        public List<IpAddress> getProtectedIpAddresses()

      • getPublicNetworkGateways

        public List<Gateway> getPublicNetworkGateways()

      • getSanStorageCapabilityFlag

        public Boolean getSanStorageCapabilityFlag()

      • setSanStorageCapabilityFlag

        public void setSanStorageCapabilityFlag​(Boolean sanStorageCapabilityFlag)

      • getScaleVlans

        public List<Vlan> getScaleVlans()

      • getSecondaryRouter

        public Hardware getSecondaryRouter()

      • setSecondaryRouter

        public void setSecondaryRouter​(Hardware secondaryRouter)

      • getSecondarySubnets

        public List<Subnet> getSecondarySubnets()

      • getTotalPrimaryIpAddressCount

        public Long getTotalPrimaryIpAddressCount()

      • setTotalPrimaryIpAddressCount

        public void setTotalPrimaryIpAddressCount​(Long totalPrimaryIpAddressCount)

      • getType

        public Type getType()

      • setType

        public void setType​(Type type)

      • getVirtualGuests

        public List<Guest> getVirtualGuests()

      • getAccountId

        public Long getAccountId()

      • setAccountId

        public void setAccountId​(Long accountId)

      • isAccountIdSpecified

        public boolean isAccountIdSpecified()

      • unsetAccountId

        public void unsetAccountId()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • isModifyDateSpecified

        public boolean isModifyDateSpecified()

      • unsetModifyDate

        public void unsetModifyDate()

      • getName

        public String getName()

      • setName

        public void setName​(String name)

      • isNameSpecified

        public boolean isNameSpecified()

      • unsetName

        public void unsetName()

      • getNote

        public String getNote()

      • setNote

        public void setNote​(String note)

      • isNoteSpecified

        public boolean isNoteSpecified()

      • unsetNote

        public void unsetNote()

      • getPrimarySubnetId

        public Long getPrimarySubnetId()

      • setPrimarySubnetId

        public void setPrimarySubnetId​(Long primarySubnetId)

      • isPrimarySubnetIdSpecified

        public boolean isPrimarySubnetIdSpecified()

      • unsetPrimarySubnetId

        public void unsetPrimarySubnetId()

      • getVlanNumber

        public Long getVlanNumber()

      • setVlanNumber

        public void setVlanNumber​(Long vlanNumber)

      • isVlanNumberSpecified

        public boolean isVlanNumberSpecified()

      • unsetVlanNumber

        public void unsetVlanNumber()

      • getAdditionalPrimarySubnetCount

        public Long getAdditionalPrimarySubnetCount()

      • setAdditionalPrimarySubnetCount

        public void setAdditionalPrimarySubnetCount​(Long additionalPrimarySubnetCount)

      • getFirewallGuestNetworkComponentCount

        public Long getFirewallGuestNetworkComponentCount()

      • setFirewallGuestNetworkComponentCount

        public void setFirewallGuestNetworkComponentCount​(Long firewallGuestNetworkComponentCount)

      • getFirewallInterfaceCount

        public Long getFirewallInterfaceCount()

      • setFirewallInterfaceCount

        public void setFirewallInterfaceCount​(Long firewallInterfaceCount)

      • getFirewallNetworkComponentCount

        public Long getFirewallNetworkComponentCount()

      • setFirewallNetworkComponentCount

        public void setFirewallNetworkComponentCount​(Long firewallNetworkComponentCount)

      • getFirewallRuleCount

        public Long getFirewallRuleCount()

      • setFirewallRuleCount

        public void setFirewallRuleCount​(Long firewallRuleCount)

      • getGuestNetworkComponentCount

        public Long getGuestNetworkComponentCount()

      • setGuestNetworkComponentCount

        public void setGuestNetworkComponentCount​(Long guestNetworkComponentCount)

      • getHardwareCount

        public Long getHardwareCount()

      • setHardwareCount

        public void setHardwareCount​(Long hardwareCount)

      • getNetworkComponentCount

        public Long getNetworkComponentCount()

      • setNetworkComponentCount

        public void setNetworkComponentCount​(Long networkComponentCount)

      • getNetworkComponentTrunkCount

        public Long getNetworkComponentTrunkCount()

      • setNetworkComponentTrunkCount

        public void setNetworkComponentTrunkCount​(Long networkComponentTrunkCount)

      • getPrimarySubnetCount

        public Long getPrimarySubnetCount()

      • setPrimarySubnetCount

        public void setPrimarySubnetCount​(Long primarySubnetCount)

      • getPrivateNetworkGatewayCount

        public Long getPrivateNetworkGatewayCount()

      • setPrivateNetworkGatewayCount

        public void setPrivateNetworkGatewayCount​(Long privateNetworkGatewayCount)

      • getProtectedIpAddressCount

        public Long getProtectedIpAddressCount()

      • setProtectedIpAddressCount

        public void setProtectedIpAddressCount​(Long protectedIpAddressCount)

      • getPublicNetworkGatewayCount

        public Long getPublicNetworkGatewayCount()

      • setPublicNetworkGatewayCount

        public void setPublicNetworkGatewayCount​(Long publicNetworkGatewayCount)

      • getScaleVlanCount

        public Long getScaleVlanCount()

      • setScaleVlanCount

        public void setScaleVlanCount​(Long scaleVlanCount)

      • getSecondarySubnetCount

        public Long getSecondarySubnetCount()

      • setSecondarySubnetCount

        public void setSecondarySubnetCount​(Long secondarySubnetCount)

      • getSubnetCount

        public Long getSubnetCount()

      • setSubnetCount

        public void setSubnetCount​(Long subnetCount)

      • getTagReferenceCount

        public Long getTagReferenceCount()

      • setTagReferenceCount

        public void setTagReferenceCount​(Long tagReferenceCount)

      • getVirtualGuestCount

        public Long getVirtualGuestCount()

      • setVirtualGuestCount

        public void setVirtualGuestCount​(Long virtualGuestCount)