Language: English

Network
SoftLayer_Network_Vlan

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.

Local Properties

accountId

The internal identifier of the SoftLayer customer account that a VLAN is associated with.

Type:

integer

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

name

The optional name for this VLAN

Type:

string

note

The note for this vlan.

Type:

string

primarySubnetId

The internal identifier of the primary subnet addressed on a VLAN.

Type:

integer

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

Relational & Count Properties

Relational Properties can be queried by object mask
account

The SoftLayer customer account associated with a VLAN.

additionalPrimarySubnetCount

A count of a VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool.

Type:

unsignedLong

additionalPrimarySubnets

A VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool.

attachedNetworkGateway

The gateway this VLAN is inside of.

attachedNetworkGatewayFlag

Whether or not this VLAN is inside a gateway.

Type:

boolean

attachedNetworkGatewayVlan

The inside VLAN record if this VLAN is inside a network gateway.

billingItem

The billing item for a network vlan.

dedicatedFirewallFlag

A flag indicating that a network vlan is on a Hardware Firewall (Dedicated).

Type:

integer

extensionRouter

The extension router that a VLAN is associated with.

firewallGuestNetworkComponentCount

A count of a firewalled Vlan's network components.

Type:

unsignedLong

firewallGuestNetworkComponents

A firewalled Vlan's network components.

firewallInterfaceCount

A count of a firewalled vlan's inbound/outbound interfaces.

Type:

unsignedLong

firewallInterfaces

A firewalled vlan's inbound/outbound interfaces.

firewallNetworkComponentCount

A count of a firewalled Vlan's network components.

Type:

unsignedLong

firewallNetworkComponents

A firewalled Vlan's network components.

firewallRuleCount

A count of the currently running rule set of a firewalled VLAN.

Type:

unsignedLong

firewallRules

The currently running rule set of a firewalled VLAN.

guestNetworkComponentCount

A count of the networking components that are connected to a VLAN.

Type:

unsignedLong

guestNetworkComponents

The networking components that are connected to a VLAN.

hardware

All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.

hardwareCount

A count of all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.

Type:

unsignedLong

highAvailabilityFirewallFlag
Type:

boolean

localDiskStorageCapabilityFlag

A flag indicating that a vlan can be assigned to a host that has local disk functionality.

Type:

boolean

network

The network in which this VLAN resides.

networkComponentCount

A count of the networking components that are connected to a VLAN.

Type:

unsignedLong

networkComponents

The networking components that are connected to a VLAN.

networkComponentTrunkCount

A count of the network components that are connected to this VLAN through a trunk.

Type:

unsignedLong

networkComponentTrunks

The network components that are connected to this VLAN through a trunk.

networkSpace

Identifier to denote whether a VLAN is used for public or private connectivity.

Type:

string

networkVlanFirewall

The Hardware Firewall (Dedicated) for a network vlan.

primaryRouter

The primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.

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.

primarySubnetCount

A count of

Type:

unsignedLong

primarySubnets
primarySubnetVersion6

A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet.

privateNetworkGatewayCount

A count of the gateways this VLAN is the private VLAN of.

Type:

unsignedLong

privateNetworkGateways

The gateways this VLAN is the private VLAN of.

protectedIpAddressCount

A count of

Type:

unsignedLong

protectedIpAddresses
publicNetworkGatewayCount

A count of the gateways this VLAN is the public VLAN of.

Type:

unsignedLong

publicNetworkGateways

The gateways this VLAN is the public VLAN of.

resourceGroupCount

A count of the resource groups in which this VLAN is a member.

Type:

unsignedLong

resourceGroupMember

The resource group member for a network vlan.

resourceGroupMemberCount

A count of the resource group member for a network vlan.

Type:

unsignedLong

resourceGroups

The resource groups in which this VLAN is a member.

sanStorageCapabilityFlag

A flag indicating that a vlan can be assigned to a host that has SAN disk functionality.

Type:

boolean

scaleVlanCount

A count of collection of scale VLANs this VLAN applies to.

Type:

unsignedLong

scaleVlans

Collection of scale VLANs this VLAN applies to.

secondaryRouter

The secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.

secondarySubnetCount

A count of the subnets that exist as secondary interfaces on a VLAN

Type:

unsignedLong

secondarySubnets

The subnets that exist as secondary interfaces on a VLAN

subnetCount

A count of all of the subnets that exist as VLAN interfaces.

Type:

unsignedLong

subnets

All of the subnets that exist as VLAN interfaces.

tagReferenceCount

A count of references to all tags for this VLAN.

Type:

unsignedLong

tagReferences

References to all tags for this VLAN.

totalPrimaryIpAddressCount

The number of primary IP addresses in a VLAN.

Type:

unsigned integer

type

The type of this VLAN.

virtualGuestCount

A count of all of the Virtual Servers that are connected to a VLAN.

Type:

unsignedLong

virtualGuests

All of the Virtual Servers that are connected to a VLAN.