SoftLayer_Network_Vlan


SoftLayer_Network_Vlan

Description

VLANs comprise the fundamental segmentation model on the network, isolating customer networks from one another.

VLANs are scoped to a single network, generally public or private, and a pod. Through association to a single VLAN, assigned subnets are routed on the network to provide IP address connectivity.

Compute devices are associated to a single VLAN per active network, to which the Primary IP Address and containing Primary Subnet belongs. Additional VLANs may be associated to bare metal devices using VLAN trunking.

VLAN at Wikipedia

Local


accountId

The identifier of the account this VLAN is assigned to.
Type: int


fullyQualifiedName

A human readable, unique identifier for this VLAN.
Type: string


id

The unique identifier of this VLAN.
Type: int


modifyDate

The time this VLAN was last modified.
Type: dateTime


name

The customer name for this VLAN.
Type: string


note

An internal description of this VLAN, if applicable.
Type: string


primarySubnetId

The identifier of a primary IPv4 subnet routed on this VLAN.
Type: int


vlanNumber

The number of this VLAN configured on the network.
Type: int

Relational


account

The account this VLAN is associated with.
Type: SoftLayer_Account


additionalPrimarySubnets

The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.
Type: SoftLayer_Network_Subnet[]


attachedNetworkGateway

The gateway device this VLAN is associated with for routing purposes.
Type: SoftLayer_Network_Gateway


attachedNetworkGatewayFlag

A value of ‘1’ indicates this VLAN is associated with a gateway device for routing purposes.
Type: boolean


attachedNetworkGatewayVlan

The gateway device VLAN context this VLAN is associated with for routing purposes.
Type: SoftLayer_Network_Gateway_Vlan


billingItem

The billing item for this VLAN.
Type: SoftLayer_Billing_Item


dedicatedFirewallFlag

A value of ‘1’ indicates this VLAN is associated with a firewall device. This does not include Hardware Firewalls.
Type: int


extensionRouter

[DEPRECATED] The extension router that this VLAN is associated with.
Type: SoftLayer_Hardware_Router

Deprecated


firewallGuestNetworkComponents

The VSI network interfaces connected to this VLAN and associated with a Hardware Firewall.
Type: SoftLayer_Network_Component_Firewall[]


firewallInterfaces

The context for the firewall device associated with this VLAN.
Type: SoftLayer_Network_Firewall_Module_Context_Interface[]


firewallNetworkComponents

The uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall.
Type: SoftLayer_Network_Component_Firewall[]


firewallRules

The access rules for the firewall device associated with this VLAN.
Type: SoftLayer_Network_Vlan_Firewall_Rule[]


guestNetworkComponents

The VSI network interfaces connected to this VLAN.
Type: SoftLayer_Virtual_Guest_Network_Component[]


hardware

The hardware with network interfaces connected natively to this VLAN.
Type: SoftLayer_Hardware[]


highAvailabilityFirewallFlag

A value of ‘1’ indicates this VLAN is associated with a firewall device in a high availability configuration.
Type: boolean


localDiskStorageCapabilityFlag

A value of ‘1’ indicates this VLAN’s pod has VSI local disk storage capability.
Type: boolean


network

[DEPRECATED] The network in which this VLAN resides.
Type: SoftLayer_Network

Deprecated


networkComponentTrunks

The hardware network interfaces connected via trunk to this VLAN.
Type: SoftLayer_Network_Component_Network_Vlan_Trunk[]


networkComponents

The hardware network interfaces connected natively to this VLAN.
Type: SoftLayer_Network_Component[]


networkComponentsTrunkable

The viable hardware network interface trunking targets of this VLAN. Viable targets include accessible components of assigned hardware in the same pod and network as this VLAN, which are not already connected, either natively or trunked.
Type: SoftLayer_Network_Component[]


networkSpace

The network that this VLAN is on, either PUBLIC or PRIVATE, if applicable.
Type: string


networkVlanFirewall

The firewall device associated with this VLAN.
Type: SoftLayer_Network_Vlan_Firewall


primaryRouter

The router device that this VLAN is associated with.
Type: SoftLayer_Hardware_Router


primarySubnet

A primary IPv4 subnet routed on this VLAN, if accessible.
Type: SoftLayer_Network_Subnet


primarySubnetVersion6

The primary IPv6 subnet routed on this VLAN, if IPv6 is enabled.
Type: SoftLayer_Network_Subnet


primarySubnets

All primary subnets routed on this VLAN.
Type: SoftLayer_Network_Subnet[]


privateNetworkGateways

The gateway devices with connectivity supported by this private VLAN.
Type: SoftLayer_Network_Gateway[]


protectedIpAddresses

IP addresses routed on this VLAN which are actively associated with network protections.
Type: SoftLayer_Network_Subnet_IpAddress[]


publicNetworkGateways

The gateway devices with connectivity supported by this public VLAN.
Type: SoftLayer_Network_Gateway[]


sanStorageCapabilityFlag

A value of ‘1’ indicates this VLAN’s pod has VSI SAN disk storage capability.
Type: boolean


scaleVlans

[DEPRECATED] The scale VLANs associated to this VLAN.
Type: SoftLayer_Scale_Network_Vlan[]

Deprecated


secondaryRouter

[DEPRECATED] The secondary router device that this VLAN is associated with.
Type: SoftLayer_Hardware

Deprecated


secondarySubnets

All non-primary subnets routed on this VLAN.
Type: SoftLayer_Network_Subnet[]


subnets

All subnets routed on this VLAN.
Type: SoftLayer_Network_Subnet[]


tagReferences

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


totalPrimaryIpAddressCount

The number of primary IPv4 addresses routed on this VLAN.
Type: unsignedInt


type

The type for this VLAN, with the following values: STANDARD, GATEWAY, INTERCONNECT
Type: SoftLayer_Network_Vlan_Type


virtualGuests

The VSIs with network interfaces connected to this VLAN.
Type: SoftLayer_Virtual_Guest[]

Count


additionalPrimarySubnetCount

A count of the primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.
Type: unsignedLong


firewallGuestNetworkComponentCount

A count of the VSI network interfaces connected to this VLAN and associated with a Hardware Firewall.
Type: unsignedLong


firewallInterfaceCount

A count of the context for the firewall device associated with this VLAN.
Type: unsignedLong


firewallNetworkComponentCount

A count of the uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall.
Type: unsignedLong


firewallRuleCount

A count of the access rules for the firewall device associated with this VLAN.
Type: unsignedLong


guestNetworkComponentCount

A count of the VSI network interfaces connected to this VLAN.
Type: unsignedLong


hardwareCount

A count of the hardware with network interfaces connected natively to this VLAN.
Type: unsignedLong


networkComponentCount

A count of the hardware network interfaces connected natively to this VLAN.
Type: unsignedLong


networkComponentTrunkCount

A count of the hardware network interfaces connected via trunk to this VLAN.
Type: unsignedLong


primarySubnetCount

A count of all primary subnets routed on this VLAN.
Type: unsignedLong


privateNetworkGatewayCount

A count of the gateway devices with connectivity supported by this private VLAN.
Type: unsignedLong


protectedIpAddressCount

A count of iP addresses routed on this VLAN which are actively associated with network protections.
Type: unsignedLong


publicNetworkGatewayCount

A count of the gateway devices with connectivity supported by this public VLAN.
Type: unsignedLong


scaleVlanCount

A count of [DEPRECATED] The scale VLANs associated to this VLAN.
Type: unsignedLong


secondarySubnetCount

A count of all non-primary subnets routed on this VLAN.
Type: unsignedLong


subnetCount

A count of all subnets routed on this VLAN.
Type: unsignedLong


tagReferenceCount

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


virtualGuestCount

A count of the VSIs with network interfaces connected to this VLAN.
Type: unsignedLong