SoftLayer Network Subnet (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Network_Subnet data type. For information on the SoftLayer_Network_Subnet service please see SoftLayer_Network_Subnet.

Contents 1 Overview 2 Local Properties 2.1 broadcastAddress 2.2 cidr 2.3 gateway 2.4 id 2.5 modifyDate 2.6 netmask 2.7 networkIdentifier 2.8 networkVlanId 2.9 subnetType 2.10 totalIpAddresses 2.11 version 3 Relational Properties 3.1 activeSwipTransaction 3.2 activeTransaction 3.3 billingItem 3.4 endPointIpAddress 3.5 hardware 3.6 ipAddresses 3.7 networkComponent 3.8 networkComponentFirewall 3.9 networkVlan 3.10 reverseDomain 3.11 swipTransaction 4 Count Properties 4.1 hardwareCount 4.2 ipAddressCount 4.3 swipTransactionCount 5 Associated Methods 6 External Links

Overview

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.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

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.

• Type: string

---

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.

• Type: integer
• Length: 2 digits

---

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.

• Type: string

---

id

A subnet's internal identifier.

• Type: integer

---

modifyDate

The last time this subnet was last modified

• Type: dateTime

---

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.

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

• Type: string
• Length: 15 characters

---

networkVlanId

A subnet's associated VLAN's internal identifier.

• Type: integer
• Length: 10 digits

---

subnetType

A subnet can be one of several types. 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. 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

---

totalIpAddresses

The number of IP addresses contained within a subnet..

• Type: non-negative integer

---

version

This is the Internet Protocol version. Current values may be either 4 or 6.

• Type: integer
• Length: 1 digit

Relational Properties

activeSwipTransaction

All the swip transactions associated with a subnet that are still active.
activeSwipTransaction can be queried by object mask.
activeSwipTransaction must be a unique value.

• Type: SoftLayer_Network_Subnet_Swip_Transaction

---

activeTransaction

The billing item for a subnet.
activeTransaction can be queried by object mask.
activeTransaction must be a unique value.

• Type: SoftLayer_Provisioning_Version1_Transaction

---

billingItem

The billing item for a subnet.
billingItem can be queried by object mask.
billingItem must be a unique value.

• Type: SoftLayer_Billing_Item

---

endPointIpAddress

A static routed ip address
endPointIpAddress can be queried by object mask.
endPointIpAddress must be a unique value.

• Type: SoftLayer_Network_Subnet_IpAddress

---

hardware

The hardware that this subnet is routed to.
hardware can be queried by object mask.

• Type: SoftLayer_HardwareArray

---

ipAddresses

All the ip addresses associated with a subnet.
ipAddresses can be queried by object mask.

• Type: SoftLayer_Network_Subnet_IpAddressArray

---

networkComponent

A subnet's associated network component.
networkComponent can be queried by object mask.
networkComponent must be a unique value.

• Type: SoftLayer_Network_Component

---

networkComponentFirewall

The upstream network component firewall.
networkComponentFirewall can be queried by object mask.
networkComponentFirewall must be a unique value.

• Type: SoftLayer_Network_Component_Firewall

---

networkVlan

The VLAN object that a subnet is associated with.
networkVlan can be queried by object mask.
networkVlan must be a unique value.

• Type: SoftLayer_Network_Vlan

---

reverseDomain

The reverse DNS domain associated with this subnet.
reverseDomain can be queried by object mask.
reverseDomain must be a unique value.

• Type: SoftLayer_Dns_Domain

---

swipTransaction

All the swip transactions associated with a subnet.
swipTransaction can be queried by object mask.

• Type: SoftLayer_Network_Subnet_Swip_TransactionArray

Count Properties

hardwareCount

A count of the hardware that this subnet is routed to.
hardwareCount must be a unique value.

• Type: unsigned long

---

ipAddressCount

A count of all the ip addresses associated with a subnet.
ipAddressCount must be a unique value.

• Type: unsigned long

---

swipTransactionCount

A count of all the swip transactions associated with a subnet.
swipTransactionCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Network_Subnet::findAllSubnetsAndActiveSwipTransactionStatus
• SoftLayer_Network_Subnet::getObject
• SoftLayer_Network_Subnet::getSubnetForIpAddress
• SoftLayer_Network_Subnet_Swip_Transaction::getSubnet
• SoftLayer_Network_Vlan::getSubnets
• SoftLayer_Network_Vlan::getSecondarySubnets

External Links

• Subnetwork at Wikipedia
• RFC950:Internet Standard Subnetting Procedure at ietf.org
• Classless Inter-Domain Routing at Wikipedia