SoftLayer_Network_Subnet

broadcastAddress

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

cidr

The Classless Inter-Domain Routing prefix of this subnet, which specifies the range of spanned IP addresses.

Classless_Inter-Domain_Routing at Wikipedia

gateway

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

id

The unique identifier of this subnet.
Type: int

isCustomerOwned

Indicates whether this subnet is owned by the assigned account.
Type: boolean

isCustomerRoutable

Indicates whether the route type of this subnet may be altered.
Type: boolean

modifyDate

The time this subnet was last modified
Type: dateTime

netmask

The bitmask in dotted-quad format for this subnet, which specifies the range of spanned IP addresses.
Type: string

networkIdentifier

The first IP address of this subnet.
Type: string

networkVlanId

The identifier of the VLAN associated to this subnet.
Type: int

note

The customer description of this subnet.
Type: string

subnetType

The product and route classifier for this routed subnet, with the following values:

• PRIMARY
• ADDITIONAL_PRIMARY
• SECONDARY_ON_VLAN
• STATIC_IP_ROUTED
• PRIMARY_6
• SUBNET_ON_VLAN
• STATIC_IP_ROUTED_6
• GLOBAL_IP
• IPSEC_STATIC_NAT

“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.

totalIpAddresses

The number of IP addresses in this subnet.
Type: decimal

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.
Type: decimal

version

The Internet Protocol version of this subnet, either 4 or 6.
Type: int

account

None
Type: SoftLayer_Account

activeRegistration

The active regional internet registration for this subnet.
Type: SoftLayer_Network_Subnet_Registration

addressSpace

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

allowedHost

The link from this subnet to network storage devices supporting access control lists.
Type: SoftLayer_Network_Storage_Allowed_Host

allowedNetworkStorage

The network storage devices this subnet has been granted access to.
Type: SoftLayer_Network_Storage[]

allowedNetworkStorageReplicas

The network storage device replicas this subnet has been granted access to.
Type: SoftLayer_Network_Storage[]

billingItem

The active billing item for this subnet.
Type: SoftLayer_Billing_Item

boundDescendants

None
Type: SoftLayer_Network_Subnet[]

boundRouterFlag

Indicates whether this subnet is associated to a network router and is routable on the network.
Type: boolean

children

The immediate descendants of this subnet.
Type: SoftLayer_Network_Subnet[]

datacenter

The datacenter this subnet is primarily associated with.
Type: SoftLayer_Location_Datacenter

descendants

The descendants of this subnet, including all parents and children.
Type: SoftLayer_Network_Subnet[]

endPointIpAddress

The IP address target of this statically routed subnet.
Type: SoftLayer_Network_Subnet_IpAddress

globalIpRecord

None
Type: SoftLayer_Network_Subnet_IpAddress_Global

hardware

The Bare Metal devices which have been assigned a primary IP address from this subnet.
Type: SoftLayer_Hardware[]

ipAddresses

The IP address records belonging to this subnet.
Type: SoftLayer_Network_Subnet_IpAddress[]

networkComponentFirewall

The hardware firewall associated to this subnet via access control list.
Type: SoftLayer_Network_Component_Firewall

networkProtectionAddresses

None
Type: SoftLayer_Network_Protection_Address[]

networkTunnelContexts

The IPSec VPN tunnels associated to this subnet.
Type: SoftLayer_Network_Tunnel_Module_Context[]

networkVlan

The VLAN this subnet is associated with.
Type: SoftLayer_Network_Vlan

podName

The pod in which this subnet is currently routed.
Type: string

protectedIpAddresses

None
Type: SoftLayer_Network_Subnet_IpAddress[]

regionalInternetRegistry

The RIR which is authoritative over the network in which this subnet resides.
Type: SoftLayer_Network_Regional_Internet_Registry

registrations

The regional internet registrations that have been created for this subnet.
Type: SoftLayer_Network_Subnet_Registration[]

reverseDomain

The reverse DNS domain associated with this subnet.
Type: SoftLayer_Dns_Domain

roleKeyName

The role identifier that this subnet is participating in. Roles dictate how a subnet may be used.
Type: string

roleName

The name of the role the subnet is within. Roles dictate how a subnet may be used.
Type: string

routingTypeKeyName

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

routingTypeName

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

tagReferences

The tags associated to this subnet.
Type: SoftLayer_Tag_Reference[]

unboundDescendants

None
Type: SoftLayer_Network_Subnet[]

utilizedIpAddressCount

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

virtualGuests

The Virtual Server devices which have been assigned a primary IP address from this subnet.
Type: SoftLayer_Virtual_Guest[]

allowedNetworkStorageCount

A count of the network storage devices this subnet has been granted access to.
Type: unsignedLong

allowedNetworkStorageReplicaCount

A count of the network storage device replicas this subnet has been granted access to.
Type: unsignedLong

boundDescendantCount

A count of
Type: unsignedLong

boundRouterCount

A count of [DEPRECATED] The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.
Type: unsignedLong

childrenCount

A count of the immediate descendants of this subnet.
Type: unsignedLong

descendantCount

A count of the descendants of this subnet, including all parents and children.
Type: unsignedLong

hardwareCount

A count of the Bare Metal devices which have been assigned a primary IP address from this subnet.
Type: unsignedLong

ipAddressCount

A count of the IP address records belonging to this subnet.
Type: unsignedLong

networkProtectionAddressCount

A count of
Type: unsignedLong

networkTunnelContextCount

A count of the IPSec VPN tunnels associated to this subnet.
Type: unsignedLong

protectedIpAddressCount

A count of
Type: unsignedLong

registrationCount

A count of the regional internet registrations that have been created for this subnet.
Type: unsignedLong

swipTransactionCount

A count of dEPRECATED
Type: unsignedLong

tagReferenceCount

A count of the tags associated to this subnet.
Type: unsignedLong

unboundDescendantCount

A count of
Type: unsignedLong

virtualGuestCount

A count of the Virtual Server devices which have been assigned a primary IP address from this subnet.
Type: unsignedLong