SoftLayer_Network_Vlan


SoftLayer_Network_Vlan

Description

This service enables interaction with VLANs assigned to your account.

Automatic VLANs are assigned as needed and are reclaimed when no longer in use.

Premium VLANs are assigned when ordered and are reclaimed when cancelled.

VLANs can be tagged for discoverability and tracking purposes.

Refer to the following services and methods for related concepts and actions involving VLANs.

Methods

editObject

Update the properties of this VLAN

getAccount

The account this VLAN is associated with.

getAdditionalPrimarySubnets

The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.

getAttachedNetworkGateway

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

getAttachedNetworkGatewayFlag

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

getAttachedNetworkGatewayVlan

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

getBillingItem

The billing item for this VLAN.

getCancelFailureReasons

A list of descriptions why this VLAN may not be cancelled.

getDedicatedFirewallFlag

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

getExtensionRouter

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

getFirewallGuestNetworkComponents

The VSI network interfaces connected to this VLAN and associated with a Hardware Firewall.

getFirewallInterfaces

The context for the firewall device associated with this VLAN.

getFirewallNetworkComponents

The uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall.

getFirewallProtectableIpAddresses

[DEPRECATED] Retrieve the IP addresses routed on this VLAN that are protectable by a Hardware Firewall.

getFirewallProtectableSubnets

[DEPRECATED] Retrieve the subnets routed on this VLAN that are protectable by a Hardware Firewall.

getFirewallRules

The access rules for the firewall device associated with this VLAN.

getGuestNetworkComponents

The VSI network interfaces connected to this VLAN.

getHardware

The hardware with network interfaces connected natively to this VLAN.

getHighAvailabilityFirewallFlag

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

getLocalDiskStorageCapabilityFlag

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

getNetwork

[DEPRECATED] The network in which this VLAN resides.

getNetworkComponentTrunks

The hardware network interfaces connected via trunk to this VLAN.

getNetworkComponents

The hardware network interfaces connected natively to this VLAN.

getNetworkComponentsTrunkable

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.

getNetworkSpace

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

getNetworkVlanFirewall

The firewall device associated with this VLAN.

getObject

Retrieve a SoftLayer_Network_Vlan record.

getPrimaryRouter

The router device that this VLAN is associated with.

getPrimarySubnet

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

getPrimarySubnetVersion6

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

getPrimarySubnets

All primary subnets routed on this VLAN.

getPrivateNetworkGateways

The gateway devices with connectivity supported by this private VLAN.

getPrivateVlan

[DEPRECATED] Retrieve a private VLAN connected to one or more hosts also connected to this public VLAN.

getPrivateVlanByIpAddress

[DEPRECATED] Retrieve the private network VLAN associated with an IP address.

getProtectedIpAddresses

IP addresses routed on this VLAN which are actively associated with network protections.

getPublicNetworkGateways

The gateway devices with connectivity supported by this public VLAN.

getPublicVlanByFqdn

[DEPRECATED] Retrieve a public VLAN by an associated host’s fully-qualified domain name

getReverseDomainRecords

[DEPRECATED] DNS PTR records associated with IP addresses routed on this VLAN.

getSanStorageCapabilityFlag

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

getScaleVlans

[DEPRECATED] The scale VLANs associated to this VLAN.

getSecondaryRouter

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

getSecondarySubnets

All non-primary subnets routed on this VLAN.

getSubnets

All subnets routed on this VLAN.

getTagReferences

The tags associated to this VLAN.

getTotalPrimaryIpAddressCount

The number of primary IPv4 addresses routed on this VLAN.

getType

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

getVirtualGuests

The VSIs with network interfaces connected to this VLAN.

getVlanForIpAddress

The VLAN on which the given IP address is routed.

setTags

Associate tags with this VLAN.

updateFirewallIntraVlanCommunication

[DEPRECATED] Update the firewall associated to this VLAN to allow or disallow intra-VLAN communication.

upgrade

Convert the VLAN to a paid resource, from an Automatic to a Premium VLAN.