SoftLayer Network Vlan (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_Vlan data type. For information on the SoftLayer_Network_Vlan service please see SoftLayer_Network_Vlan.
Contents |
Overview
The SoftLayer_Network_Vlan data type models a single VLAN within SoftLayer's public and private networks. a Virtual LAN is a structure that associates network interfaces on routers, switches, and servers in different locations to act as if they were on the same local network broadcast domain. VLANs are a central part of the SoftLayer network. They can determine how new IP subnets are routed and how individual servers communicate to each other.
| 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
accountId
The internal identifier of the SoftLayer customer account that a VLAN is associated with.
- Type: integer
- Length: 10 digits
id
A VLAN's internal identifier. This should not be confused with the vlanNumber property, which is used in network configuration.
- Type: integer
modifyDate
The date a VLAN was last modified.
- Type: dateTime
note
The note for this vlan.
- Type: string
- Length: 100 characters
primarySubnetId
The internal identifier of the primary subnet addressed on a VLAN.
- Type: integer
- Length: 10 digits
vlanNumber
A VLAN's number as recorded within the SoftLayer network. This is configured directly on SoftLayer's networking equipment and should not be confused with a VLAN's id property.
- Type: integer
- Length: 5 digits
Relational Properties
account
The SoftLayer customer account associated with a VLAN.
account can be queried by object mask.
account must be a unique value.
- Type: SoftLayer_Account
hardware
All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.
hardware can be queried by object mask.
- Type: SoftLayer_HardwareArray
networkComponents
The networking components that are connected to a VLAN.
networkComponents can be queried by object mask.
primaryRouter
The primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.
primaryRouter can be queried by object mask.
primaryRouter must be a unique value.
- Type: SoftLayer_Hardware
primarySubnet
A VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased.
primarySubnet can be queried by object mask.
primarySubnet must be a unique value.
- Type: SoftLayer_Network_Subnet
secondaryRouter
The secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.
secondaryRouter can be queried by object mask.
secondaryRouter must be a unique value.
- Type: SoftLayer_Hardware
secondarySubnets
The subnets that exist as secondary interfaces on a VLAN
secondarySubnets can be queried by object mask.
subnets
All of the subnets that exist as VLAN interfaces.
subnets can be queried by object mask.
Count Properties
hardwareCount
A count of all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.
hardwareCount must be a unique value.
- Type: unsigned long
networkComponentCount
A count of the networking components that are connected to a VLAN.
networkComponentCount must be a unique value.
- Type: unsigned long
secondarySubnetCount
A count of the subnets that exist as secondary interfaces on a VLAN
secondarySubnetCount must be a unique value.
- Type: unsigned long
subnetCount
A count of all of the subnets that exist as VLAN interfaces.
subnetCount must be a unique value.
- Type: unsigned long
Associated Methods
- SoftLayer_Network_Subnet::getNetworkVlan
- SoftLayer_Network_Vlan::getObject
- SoftLayer_Network_Vlan::getVlanForIpAddress
- SoftLayer_Network_Vlan::getPrivateVlanByIpAddress
- SoftLayer_Network_Vlan::getPrivateVlan
- SoftLayer_Network_Vlan::getPublicVlanByFqdn
