"SoftLayer_" prefix removed for readability.
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.
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.
Type: string
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.
Type: integer
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.
Type: string
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.
Type: string
A subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface.
Type: string
A subnet can be one of several types. PRIMARY, ADDITIONAL_PRIMARY, SECONDARY, ROUTED_TO_VLAN, SECONDARY_ON_VLAN, and STATIC_IP_ROUTED. The type determines the order in which many subnets are sorted in the SoftLayer customer portal. This groups subnets of similar type together.
Type: string
A subnet can be one of several types. PRIMARY, ADDITIONAL_PRIMARY, SECONDARY, ROUTED_TO_VLAN, SECONDARY_ON_VLAN, and STATIC_IP_ROUTED. 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” subnet is any of the secondary subnet's bound to a VLAN interface. A “ROUTED_TO_VLAN” subnet is a portable subnet that can be routed to any server on a vlan. A “SECONDARY_ON_VLAN” subnet also doesn't exist as a VLAN interface, but is routed directly to a VLAN instead of a single IP address by SoftLayer's routers.
Type: string
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
If present, the active registration for this subnet.
Type: SoftLayer_Network_Subnet_Registration
Identifier which distinguishes what classification of addresses the subnet represents.
Type: string
The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.
Type: SoftLayer_Network_Storage_Allowed_Host
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Type: SoftLayer_Network_Storage[]
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Type: SoftLayer_Network_Storage[]
Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed.
Type: boolean
All the ip addresses associated with a subnet.
Type: SoftLayer_Network_Subnet_IpAddress[]
The upstream network component firewall.
Type: SoftLayer_Network_Component_Firewall
IPSec network tunnels that have access to a private subnet.
Type: SoftLayer_Network_Tunnel_Module_Context[]
All registrations that have been created for this subnet.
Type: SoftLayer_Network_Subnet_Registration[]
An identifier of the role the subnet is within. 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 identifier for the type of route then subnet is currently configured for.
Type: string
The name for the type of route then subnet is currently configured for.
Type: string
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.
Type: unsigned integer
The Virtual Servers using IP addresses on this subnet.
Type: SoftLayer_Virtual_Guest[]
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Type: unsigned long
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Type: unsigned long
A count of iPSec network tunnels that have access to a private subnet.
Type: unsigned long
A count of all registrations that have been created for this subnet.
Type: unsigned long
A count of the Virtual Servers using IP addresses on this subnet.
Type: unsigned long