Package com.softlayer.api.service.network

Class Subnet

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.Subnet
@ApiType("SoftLayer_Network_Subnet")
public class Subnet
extends Entity
The SoftLayer_Network_Subnet data type contains general information relating to a single SoftLayer subnet. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account.
See Also:
SoftLayer_Network_Subnet

  • Field Details

    • account

      @ApiProperty protected Account account

    • activeRegistration

      @ApiProperty protected Registration activeRegistration
      If present, the active registration for this subnet.

    • activeSwipTransaction

      @ApiProperty protected Transaction activeSwipTransaction
      DEPRECATED

    • activeTransaction

      @ApiProperty protected Transaction activeTransaction
      The billing item for a subnet.

    • addressSpace

      @ApiProperty protected String addressSpace
      Identifier which distinguishes what classification of addresses the subnet represents.

    • allowedHost

      @ApiProperty protected Host allowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.

    • allowedNetworkStorage

      @ApiProperty protected List<Storage> allowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

    • allowedNetworkStorageReplicas

      @ApiProperty protected List<Storage> allowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

    • billingItem

      @ApiProperty protected Item billingItem
      The billing item for a subnet.

    • boundDescendants

      @ApiProperty protected List<Subnet> boundDescendants

    • boundRouterFlag

      @ApiProperty protected Boolean boundRouterFlag
      Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed.

    • boundRouters

      @ApiProperty protected List<Hardware> boundRouters

    • children

      @ApiProperty protected List<Subnet> children

    • datacenter

      @ApiProperty protected Datacenter datacenter
      The data center this subnet may be routed within.

    • descendants

      @ApiProperty protected List<Subnet> descendants

    • displayLabel

      @ApiProperty protected String displayLabel

    • endPointIpAddress

      @ApiProperty protected IpAddress endPointIpAddress
      A static routed ip address

    • globalIpRecord

      @ApiProperty protected Global globalIpRecord

    • hardware

      @ApiProperty protected List<Hardware> hardware
      The hardware using IP addresses on this subnet.

    • ipAddresses

      @ApiProperty protected List<IpAddress> ipAddresses
      All the ip addresses associated with a subnet.

    • networkComponentFirewall

      @ApiProperty protected Firewall networkComponentFirewall
      The upstream network component firewall.

    • networkProtectionAddresses

      @ApiProperty protected List<Address> networkProtectionAddresses

    • networkTunnelContexts

      @ApiProperty protected List<Context> networkTunnelContexts
      IPSec network tunnels that have access to a private subnet.

    • networkVlan

      @ApiProperty protected Vlan networkVlan
      The VLAN object that a subnet is associated with.

    • podName

      @ApiProperty protected String podName
      The pod in which this subnet resides.

    • protectedIpAddresses

      @ApiProperty protected List<IpAddress> protectedIpAddresses

    • regionalInternetRegistry

      @ApiProperty protected Registry regionalInternetRegistry

    • registrations

      @ApiProperty protected List<Registration> registrations
      All registrations that have been created for this subnet.

    • reverseDomain

      @ApiProperty protected Domain reverseDomain
      The reverse DNS domain associated with this subnet.

    • roleKeyName

      @ApiProperty protected String roleKeyName
      An identifier of the role the subnet is within. Roles dictate how a subnet may be used.

    • roleName

      @ApiProperty protected String roleName
      The name of the role the subnet is within. Roles dictate how a subnet may be used.

    • routingTypeKeyName

      @ApiProperty protected String routingTypeKeyName
      The identifier for the type of route then subnet is currently configured for.

    • routingTypeName

      @ApiProperty protected String routingTypeName
      The name for the type of route then subnet is currently configured for.

    • swipTransaction

      @ApiProperty protected List<Transaction> swipTransaction
      DEPRECATED

    • tagReferences

      @ApiProperty protected List<Reference> tagReferences
      References to all tags for this subnet.

    • unboundDescendants

      @ApiProperty protected List<Subnet> unboundDescendants

    • utilizedIpAddressCount

      @ApiProperty protected Long utilizedIpAddressCount
      Provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types.

    • virtualGuests

      @ApiProperty protected List<Guest> virtualGuests
      The Virtual Servers using IP addresses on this subnet.

    • broadcastAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String broadcastAddress
      The last IP address in a subnet is the subnet's broadcast address. This is an IP address that will broadcast network requests to the entire subnet and may not be assigned to a network interface.

    • broadcastAddressSpecified

      protected boolean broadcastAddressSpecified

    • cidr

      @ApiProperty(canBeNullOrNotSet=true) protected Long cidr
      A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and 32 signifying the number of bits in a subnet's netmask. These bits separate a subnet's network address from it's host addresses. It performs the same function as the ''netmask'' property, but is represented as an integer.

    • cidrSpecified

      protected boolean cidrSpecified

    • gateway

      @ApiProperty(canBeNullOrNotSet=true) protected String gateway
      A subnet's gateway address. This is an IP address that belongs to the router on the subnet and may not be assigned to a network interface.

    • gatewaySpecified

      protected boolean gatewaySpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      A subnet's internal identifier.

    • idSpecified

      protected boolean idSpecified

    • isCustomerOwned

      @ApiProperty(canBeNullOrNotSet=true) protected Boolean isCustomerOwned

    • isCustomerOwnedSpecified

      protected boolean isCustomerOwnedSpecified

    • isCustomerRoutable

      @ApiProperty(canBeNullOrNotSet=true) protected Boolean isCustomerRoutable

    • isCustomerRoutableSpecified

      protected boolean isCustomerRoutableSpecified

    • modifyDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      The last time this subnet was last modified

    • modifyDateSpecified

      protected boolean modifyDateSpecified

    • netmask

      @ApiProperty(canBeNullOrNotSet=true) protected String netmask
      A bitmask in dotted-quad format that is used to separate a subnet's network address from it's host addresses. This performs the same function as the ''cidr'' property, but is expressed in a string format.

    • netmaskSpecified

      protected boolean netmaskSpecified

    • networkIdentifier

      @ApiProperty(canBeNullOrNotSet=true) protected String networkIdentifier
      A subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface.

    • networkIdentifierSpecified

      protected boolean networkIdentifierSpecified

    • networkVlanId

      @ApiProperty(canBeNullOrNotSet=true) protected Long networkVlanId
      A subnet's associated VLAN's internal identifier.

    • networkVlanIdSpecified

      protected boolean networkVlanIdSpecified

    • note

      @ApiProperty(canBeNullOrNotSet=true) protected String note
      This is the note field.

    • noteSpecified

      protected boolean noteSpecified

    • sortOrder

      @ApiProperty(canBeNullOrNotSet=true) protected String sortOrder
      Used to sort subnets and group subnets of similar type together for use on customer facing portals.

    • sortOrderSpecified

      protected boolean sortOrderSpecified

    • subnetType

      @ApiProperty(canBeNullOrNotSet=true) protected String subnetType
      A subnet type can be any of the following:
      * PRIMARY
      * ADDITIONAL_PRIMARY
      * SECONDARY_ON_VLAN
      * STATIC_IP_ROUTED
      * PRIMARY_6
      * SUBNET_ON_VLAN
      * STATIC_IP_ROUTED_6
      * GLOBAL_IP
      A "PRIMARY" subnet is the primary network bound to a VLAN within the softlayer network. An "ADDITIONAL_PRIMARY" subnet is bound to a network VLAN to augment the pool of available primary IP addresses that may be assigned to a server. A "SECONDARY_ON_VLAN" subnet is a secondary portable subnet whose IP addresses are managed by the end user. "STATIC_IP_ROUTED" subnets are subnets that are statically routed to a single endpoint IP address. A "PRIMARY_6" subnet is the primary IPv6 network bound to a VLAN. A "SUBNET_ON_VLAN" subnet is the secondary portable IPv6 subnet whose IP addresses are managed by the end user. A "STATIC_IP_ROUTED_6" subnet is statically routed to a single IPv6 endpoint IP address. A "GLOBAL_IP" subnet is a subnet that is routable to a single endpoint IP address. The "GLOBAL_IP" type is used for both IPv4 and IPv6 subnets.

    • subnetTypeSpecified

      protected boolean subnetTypeSpecified

    • totalIpAddresses

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal totalIpAddresses
      The number of IP addresses contained within this subnet.

    • totalIpAddressesSpecified

      protected boolean totalIpAddressesSpecified

    • usableIpAddressCount

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal usableIpAddressCount
      The number of IP addresses that can be addressed within this subnet. For IPv4 subnets with a CIDR value of at most 30, a discount of 3 is taken from the total number of IP addresses for the subnet's unusable network, gateway and broadcast IP addresses. For IPv6 subnets with a CIDR value of at most 126, a discount of 2 is taken for the subnet's network and gateway IP addresses.

    • usableIpAddressCountSpecified

      protected boolean usableIpAddressCountSpecified

    • version

      @ApiProperty(canBeNullOrNotSet=true) protected Long version
      This is the Internet Protocol version. Current values may be either 4 or 6.

    • versionSpecified

      protected boolean versionSpecified

    • allowedNetworkStorageCount

      @ApiProperty protected Long allowedNetworkStorageCount
      A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

    • allowedNetworkStorageReplicaCount

      @ApiProperty protected Long allowedNetworkStorageReplicaCount
      A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

    • boundDescendantCount

      @ApiProperty protected Long boundDescendantCount
      A count of

    • boundRouterCount

      @ApiProperty protected Long boundRouterCount
      A count of

    • childrenCount

      @ApiProperty protected Long childrenCount
      A count of

    • descendantCount

      @ApiProperty protected Long descendantCount
      A count of

    • hardwareCount

      @ApiProperty protected Long hardwareCount
      A count of the hardware using IP addresses on this subnet.

    • ipAddressCount

      @ApiProperty protected Long ipAddressCount
      A count of all the ip addresses associated with a subnet.

    • networkProtectionAddressCount

      @ApiProperty protected Long networkProtectionAddressCount
      A count of

    • networkTunnelContextCount

      @ApiProperty protected Long networkTunnelContextCount
      A count of iPSec network tunnels that have access to a private subnet.

    • protectedIpAddressCount

      @ApiProperty protected Long protectedIpAddressCount
      A count of

    • registrationCount

      @ApiProperty protected Long registrationCount
      A count of all registrations that have been created for this subnet.

    • swipTransactionCount

      @ApiProperty protected Long swipTransactionCount
      A count of dEPRECATED

    • tagReferenceCount

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

    • unboundDescendantCount

      @ApiProperty protected Long unboundDescendantCount
      A count of

    • virtualGuestCount

      @ApiProperty protected Long virtualGuestCount
      A count of the Virtual Servers using IP addresses on this subnet.

  • Constructor Details

    • Subnet

      public Subnet()

  • Method Details

    • getAccount

      public Account getAccount()

    • setAccount

      public void setAccount​(Account account)

    • getActiveRegistration

      public Registration getActiveRegistration()

    • setActiveRegistration

      public void setActiveRegistration​(Registration activeRegistration)

    • getActiveSwipTransaction

      public Transaction getActiveSwipTransaction()

    • setActiveSwipTransaction

      public void setActiveSwipTransaction​(Transaction activeSwipTransaction)

    • getActiveTransaction

      public Transaction getActiveTransaction()

    • setActiveTransaction

      public void setActiveTransaction​(Transaction activeTransaction)

    • getAddressSpace

      public String getAddressSpace()

    • setAddressSpace

      public void setAddressSpace​(String addressSpace)

    • getAllowedHost

      public Host getAllowedHost()

    • setAllowedHost

      public void setAllowedHost​(Host allowedHost)

    • getAllowedNetworkStorage

      public List<Storage> getAllowedNetworkStorage()

    • getAllowedNetworkStorageReplicas

      public List<Storage> getAllowedNetworkStorageReplicas()

    • getBillingItem

      public Item getBillingItem()

    • setBillingItem

      public void setBillingItem​(Item billingItem)

    • getBoundDescendants

      public List<Subnet> getBoundDescendants()

    • getBoundRouterFlag

      public Boolean getBoundRouterFlag()

    • setBoundRouterFlag

      public void setBoundRouterFlag​(Boolean boundRouterFlag)

    • getBoundRouters

      public List<Hardware> getBoundRouters()

    • getChildren

      public List<Subnet> getChildren()

    • getDatacenter

      public Datacenter getDatacenter()

    • setDatacenter

      public void setDatacenter​(Datacenter datacenter)

    • getDescendants

      public List<Subnet> getDescendants()

    • getDisplayLabel

      public String getDisplayLabel()

    • setDisplayLabel

      public void setDisplayLabel​(String displayLabel)

    • getEndPointIpAddress

      public IpAddress getEndPointIpAddress()

    • setEndPointIpAddress

      public void setEndPointIpAddress​(IpAddress endPointIpAddress)

    • getGlobalIpRecord

      public Global getGlobalIpRecord()

    • setGlobalIpRecord

      public void setGlobalIpRecord​(Global globalIpRecord)

    • getHardware

      public List<Hardware> getHardware()

    • getIpAddresses

      public List<IpAddress> getIpAddresses()

    • getNetworkComponentFirewall

      public Firewall getNetworkComponentFirewall()

    • setNetworkComponentFirewall

      public void setNetworkComponentFirewall​(Firewall networkComponentFirewall)

    • getNetworkProtectionAddresses

      public List<Address> getNetworkProtectionAddresses()

    • getNetworkTunnelContexts

      public List<Context> getNetworkTunnelContexts()

    • getNetworkVlan

      public Vlan getNetworkVlan()

    • setNetworkVlan

      public void setNetworkVlan​(Vlan networkVlan)

    • getPodName

      public String getPodName()

    • setPodName

      public void setPodName​(String podName)

    • getProtectedIpAddresses

      public List<IpAddress> getProtectedIpAddresses()

    • getRegionalInternetRegistry

      public Registry getRegionalInternetRegistry()

    • setRegionalInternetRegistry

      public void setRegionalInternetRegistry​(Registry regionalInternetRegistry)

    • getRegistrations

      public List<Registration> getRegistrations()

    • getReverseDomain

      public Domain getReverseDomain()

    • setReverseDomain

      public void setReverseDomain​(Domain reverseDomain)

    • getRoleKeyName

      public String getRoleKeyName()

    • setRoleKeyName

      public void setRoleKeyName​(String roleKeyName)

    • getRoleName

      public String getRoleName()

    • setRoleName

      public void setRoleName​(String roleName)

    • getRoutingTypeKeyName

      public String getRoutingTypeKeyName()

    • setRoutingTypeKeyName

      public void setRoutingTypeKeyName​(String routingTypeKeyName)

    • getRoutingTypeName

      public String getRoutingTypeName()

    • setRoutingTypeName

      public void setRoutingTypeName​(String routingTypeName)

    • getSwipTransaction

      public List<Transaction> getSwipTransaction()

    • getTagReferences

      public List<Reference> getTagReferences()

    • getUnboundDescendants

      public List<Subnet> getUnboundDescendants()

    • getUtilizedIpAddressCount

      public Long getUtilizedIpAddressCount()

    • setUtilizedIpAddressCount

      public void setUtilizedIpAddressCount​(Long utilizedIpAddressCount)

    • getVirtualGuests

      public List<Guest> getVirtualGuests()

    • getBroadcastAddress

      public String getBroadcastAddress()

    • setBroadcastAddress

      public void setBroadcastAddress​(String broadcastAddress)

    • isBroadcastAddressSpecified

      public boolean isBroadcastAddressSpecified()

    • unsetBroadcastAddress

      public void unsetBroadcastAddress()

    • getCidr

      public Long getCidr()

    • setCidr

      public void setCidr​(Long cidr)

    • isCidrSpecified

      public boolean isCidrSpecified()

    • unsetCidr

      public void unsetCidr()

    • getGateway

      public String getGateway()

    • setGateway

      public void setGateway​(String gateway)

    • isGatewaySpecified

      public boolean isGatewaySpecified()

    • unsetGateway

      public void unsetGateway()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getIsCustomerOwned

      public Boolean getIsCustomerOwned()

    • setIsCustomerOwned

      public void setIsCustomerOwned​(Boolean isCustomerOwned)

    • isIsCustomerOwnedSpecified

      public boolean isIsCustomerOwnedSpecified()

    • unsetIsCustomerOwned

      public void unsetIsCustomerOwned()

    • getIsCustomerRoutable

      public Boolean getIsCustomerRoutable()

    • setIsCustomerRoutable

      public void setIsCustomerRoutable​(Boolean isCustomerRoutable)

    • isIsCustomerRoutableSpecified

      public boolean isIsCustomerRoutableSpecified()

    • unsetIsCustomerRoutable

      public void unsetIsCustomerRoutable()

    • getModifyDate

      public GregorianCalendar getModifyDate()

    • setModifyDate

      public void setModifyDate​(GregorianCalendar modifyDate)

    • isModifyDateSpecified

      public boolean isModifyDateSpecified()

    • unsetModifyDate

      public void unsetModifyDate()

    • getNetmask

      public String getNetmask()

    • setNetmask

      public void setNetmask​(String netmask)

    • isNetmaskSpecified

      public boolean isNetmaskSpecified()

    • unsetNetmask

      public void unsetNetmask()

    • getNetworkIdentifier

      public String getNetworkIdentifier()

    • setNetworkIdentifier

      public void setNetworkIdentifier​(String networkIdentifier)

    • isNetworkIdentifierSpecified

      public boolean isNetworkIdentifierSpecified()

    • unsetNetworkIdentifier

      public void unsetNetworkIdentifier()

    • getNetworkVlanId

      public Long getNetworkVlanId()

    • setNetworkVlanId

      public void setNetworkVlanId​(Long networkVlanId)

    • isNetworkVlanIdSpecified

      public boolean isNetworkVlanIdSpecified()

    • unsetNetworkVlanId

      public void unsetNetworkVlanId()

    • getNote

      public String getNote()

    • setNote

      public void setNote​(String note)

    • isNoteSpecified

      public boolean isNoteSpecified()

    • unsetNote

      public void unsetNote()

    • getSortOrder

      public String getSortOrder()

    • setSortOrder

      public void setSortOrder​(String sortOrder)

    • isSortOrderSpecified

      public boolean isSortOrderSpecified()

    • unsetSortOrder

      public void unsetSortOrder()

    • getSubnetType

      public String getSubnetType()

    • setSubnetType

      public void setSubnetType​(String subnetType)

    • isSubnetTypeSpecified

      public boolean isSubnetTypeSpecified()

    • unsetSubnetType

      public void unsetSubnetType()

    • getTotalIpAddresses

      public BigDecimal getTotalIpAddresses()

    • setTotalIpAddresses

      public void setTotalIpAddresses​(BigDecimal totalIpAddresses)

    • isTotalIpAddressesSpecified

      public boolean isTotalIpAddressesSpecified()

    • unsetTotalIpAddresses

      public void unsetTotalIpAddresses()

    • getUsableIpAddressCount

      public BigDecimal getUsableIpAddressCount()

    • setUsableIpAddressCount

      public void setUsableIpAddressCount​(BigDecimal usableIpAddressCount)

    • isUsableIpAddressCountSpecified

      public boolean isUsableIpAddressCountSpecified()

    • unsetUsableIpAddressCount

      public void unsetUsableIpAddressCount()

    • getVersion

      public Long getVersion()

    • setVersion

      public void setVersion​(Long version)

    • isVersionSpecified

      public boolean isVersionSpecified()

    • unsetVersion

      public void unsetVersion()

    • getAllowedNetworkStorageCount

      public Long getAllowedNetworkStorageCount()

    • setAllowedNetworkStorageCount

      public void setAllowedNetworkStorageCount​(Long allowedNetworkStorageCount)

    • getAllowedNetworkStorageReplicaCount

      public Long getAllowedNetworkStorageReplicaCount()

    • setAllowedNetworkStorageReplicaCount

      public void setAllowedNetworkStorageReplicaCount​(Long allowedNetworkStorageReplicaCount)

    • getBoundDescendantCount

      public Long getBoundDescendantCount()

    • setBoundDescendantCount

      public void setBoundDescendantCount​(Long boundDescendantCount)

    • getBoundRouterCount

      public Long getBoundRouterCount()

    • setBoundRouterCount

      public void setBoundRouterCount​(Long boundRouterCount)

    • getChildrenCount

      public Long getChildrenCount()

    • setChildrenCount

      public void setChildrenCount​(Long childrenCount)

    • getDescendantCount

      public Long getDescendantCount()

    • setDescendantCount

      public void setDescendantCount​(Long descendantCount)

    • getHardwareCount

      public Long getHardwareCount()

    • setHardwareCount

      public void setHardwareCount​(Long hardwareCount)

    • getIpAddressCount

      public Long getIpAddressCount()

    • setIpAddressCount

      public void setIpAddressCount​(Long ipAddressCount)

    • getNetworkProtectionAddressCount

      public Long getNetworkProtectionAddressCount()

    • setNetworkProtectionAddressCount

      public void setNetworkProtectionAddressCount​(Long networkProtectionAddressCount)

    • getNetworkTunnelContextCount

      public Long getNetworkTunnelContextCount()

    • setNetworkTunnelContextCount

      public void setNetworkTunnelContextCount​(Long networkTunnelContextCount)

    • getProtectedIpAddressCount

      public Long getProtectedIpAddressCount()

    • setProtectedIpAddressCount

      public void setProtectedIpAddressCount​(Long protectedIpAddressCount)

    • getRegistrationCount

      public Long getRegistrationCount()

    • setRegistrationCount

      public void setRegistrationCount​(Long registrationCount)

    • getSwipTransactionCount

      public Long getSwipTransactionCount()

    • setSwipTransactionCount

      public void setSwipTransactionCount​(Long swipTransactionCount)

    • getTagReferenceCount

      public Long getTagReferenceCount()

    • setTagReferenceCount

      public void setTagReferenceCount​(Long tagReferenceCount)

    • getUnboundDescendantCount

      public Long getUnboundDescendantCount()

    • setUnboundDescendantCount

      public void setUnboundDescendantCount​(Long unboundDescendantCount)

    • getVirtualGuestCount

      public Long getVirtualGuestCount()

    • setVirtualGuestCount

      public void setVirtualGuestCount​(Long virtualGuestCount)

    • asService

      public Subnet.Service asService​(ApiClient client)

    • service

      public static Subnet.Service service​(ApiClient client)

    • service

      public static Subnet.Service service​(ApiClient client, Long id)