"SoftLayer_" prefix removed for readability.
A subnet represents a continguous range of IP addresses. The range is represented by the networkIdentifer and cidr/netmask properties. The version of a subnet, whether IPv4 or IPv6, is represented by the version property.
When routed, a subnet is associated to a VLAN on your account, which defines its scope on the network. Depending on a subnet’s route type, IP addresses may be reserved for network and internal functions, the most common of which is the allocation of network, gateway and broadcast IP addresses.
An unrouted subnet is not active on the network and may generally be routed within the datacenter in which it resides.
RFC950:Internet Standard Subnetting Procedure
The IP address of this subnet reserved for use as a broadcast address and which is unavailable for other use. Network traffic targeting this IP address will be broadcast to the entire subnet.
Type:
string
The Classless Inter-Domain Routing prefix of this subnet, which specifies the range of spanned IP addresses.
Classless_Inter-Domain_Routing at Wikipedia
The IP address of this subnet reserved for use on the router as a gateway address and which is unavailable for other use.
Type:
string
The bitmask in dotted-quad format for this subnet, which specifies the range of spanned IP addresses.
Type:
string
[DEPRECATED] Used to sort subnets and group subnets of similar type together for use on customer facing portals.
Type:
string
Deprecated
The product and route classifier for this routed subnet, with the following values:
“PRIMARY” refers to the principal IPv4 network from which primary IP addresses are assigned to devices.
“ADDITIONAL_PRIMARY” refers to extra IPv4 networks from which primary IP addresses are assigned to devices.
“SECONDARY_ON_VLAN” refers to a secondary IPv4 subnet routed as portable.
“STATIC_IP_ROUTED” refers to a secondary IPv4 subnet routed as static to a single endpoint IPv4 address.
“PRIMARY_6” refers to the IPv6 network from which primary IPv6 addresses are assigned to devices.
“SUBNET_ON_VLAN” refers to a secondary IPv6 subnet routed as portable.
“STATIC_IP_ROUTED_6” refers to a secondary IPv6 subnet routed as static to a single endpoint IPv6 address.
“GLOBAL_IP” refers to a global IPv4/IPv6 address routed as static to a single endpoint IP address.
“IPSEC_STATIC_NAT” refers to the networks associated to your IPSec VPN tunnels for NAT purposes.
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.
Type:
decimal
The active regional internet registration for this subnet.
Type:
SoftLayer_Network_Subnet_Registration
The classifier of IP addresses this subnet represents, generally PUBLIC or PRIVATE. This does not necessarily correlate with the network on which the subnet is used.
Type:
string
The link from this subnet to network storage devices supporting access control lists.
Type:
SoftLayer_Network_Storage_Allowed_Host
The network storage devices this subnet has been granted access to.
Type:
SoftLayer_Network_Storage[]
The network storage device replicas this subnet has been granted access to.
Type:
SoftLayer_Network_Storage[]
Indicates whether this subnet is associated to a network router and is routable on the network.
Type:
boolean
The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.
Type:
SoftLayer_Hardware[]
The datacenter this subnet is primarily associated with.
Type:
SoftLayer_Location_Datacenter
The descendants of this subnet, including all parents and children.
Type:
SoftLayer_Network_Subnet[]
The IP address target of this statically routed subnet.
Type:
SoftLayer_Network_Subnet_IpAddress
The Bare Metal devices which have been assigned a primary IP address from this subnet.
Type:
SoftLayer_Hardware[]
The IP address records belonging to this subnet.
Type:
SoftLayer_Network_Subnet_IpAddress[]
The hardware firewall associated to this subnet via access control list.
Type:
SoftLayer_Network_Component_Firewall
The IPSec VPN tunnels associated to this subnet.
Type:
SoftLayer_Network_Tunnel_Module_Context[]
The RIR which is authoritative over the network in which this subnet resides.
Type:
SoftLayer_Network_Regional_Internet_Registry
The regional internet registrations that have been created for this subnet.
Type:
SoftLayer_Network_Subnet_Registration[]
The role identifier that this subnet is participating in. Roles dictate how a subnet may be used.
Type:
string
The name of the role the subnet is within. Roles dictate how a subnet may be used.
Type:
string
The product and route classifier for this routed subnet, with the following values: PRIMARY, SECONDARY, STATIC_TO_IP, GLOBAL_IP, IPSEC_STATIC_NAT.
Type:
string
The description of the product and route classifier for this routed subnet, with the following values: Primary, Portable, Static, Global, IPSec Static NAT.
Type:
string
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 subnets.
Type:
unsignedInt
The Virtual Server devices which have been assigned a primary IP address from this subnet.
Type:
SoftLayer_Virtual_Guest[]
A count of the network storage devices this subnet has been granted access to.
Type:
unsignedLong
A count of the network storage device replicas this subnet has been granted access to.
Type:
unsignedLong
A count of the list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.
Type:
unsignedLong
A count of the descendants of this subnet, including all parents and children.
Type:
unsignedLong
A count of the Bare Metal devices which have been assigned a primary IP address from this subnet.
Type:
unsignedLong
A count of the IPSec VPN tunnels associated to this subnet.
Type:
unsignedLong
A count of the regional internet registrations that have been created for this subnet.
Type:
unsignedLong
A count of the Virtual Server devices which have been assigned a primary IP address from this subnet.
Type:
unsignedLong