All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Vlan

@ApiService("SoftLayer_Network_Vlan")
public static interface Vlan.Service
extends Service

Virtual LANs are an integral part of SoftLayer' s public and private networks. A VLAN is a networking concept in which network interfaces on different routers, switches, and servers act as if they're on the same local network broadcast domain. This kind of network segmentation helps keep SoftLayer customers' networks separate from each other and provides a convenient mechanism for routing new IP subnets to servers. They also enable easy IP address sharing and swapping between servers on the same VLAN. SoftLayer servers are provisioned on private VLANs per router on the public and private networks.

The SoftLayer_Network_Vlan service controls these VLANs and provides relationships between VLANs, subnets, IP addresses, and network components.

See Also:: SoftLayer_Network_Vlan

Method Summary

Modifier and Type	Method	Description
`Vlan.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`editObject(Vlan templateObject)`	Edit a VLAN's properties
`Account`	`getAccount()`	The SoftLayer customer account associated with a VLAN.
`List<Subnet>`	`getAdditionalPrimarySubnets()`	A VLAN's additional primary subnets.
`Gateway`	`getAttachedNetworkGateway()`	The gateway this VLAN is inside of.
`Boolean`	`getAttachedNetworkGatewayFlag()`	Whether or not this VLAN is inside a gateway.
`Vlan`	`getAttachedNetworkGatewayVlan()`	The inside VLAN record if this VLAN is inside a network gateway.
`Item`	`getBillingItem()`	The billing item for a network vlan.
`List<String>`	`getCancelFailureReasons()`	Get a set of reasons why this VLAN may not be cancelled.
`Long`	`getDedicatedFirewallFlag()`	A flag indicating that a network vlan is on a Hardware Firewall (Dedicated).
`Router`	`getExtensionRouter()`	The extension router that a VLAN is associated with.
`List<Firewall>`	`getFirewallGuestNetworkComponents()`	A firewalled Vlan's network components.
`List<Interface>`	`getFirewallInterfaces()`	A firewalled vlan's inbound/outbound interfaces.
`List<Firewall>`	`getFirewallNetworkComponents()`	A firewalled Vlan's network components.
`List<IpAddress>`	`getFirewallProtectableIpAddresses()`	Get the IP addresses associated with this server that are protectable by a network component firewall.
`List<Subnet>`	`getFirewallProtectableSubnets()`	Get the subnets associated with this server that are protectable by a network component firewall.
`List<Rule>`	`getFirewallRules()`	The currently running rule set of a firewalled VLAN.
`List<Component>`	`getGuestNetworkComponents()`	The networking components that are connected to a VLAN.
`List<Hardware>`	`getHardware()`	All of the hardware that exists on a VLAN.
`Boolean`	`getHighAvailabilityFirewallFlag()`
`Boolean`	`getLocalDiskStorageCapabilityFlag()`	A flag indicating that a vlan can be assigned to a host that has local disk functionality.
`Network`	`getNetwork()`	The network in which this VLAN resides.
`List<Component>`	`getNetworkComponents()`	The networking components that are connected to a VLAN.
`List<Trunk>`	`getNetworkComponentTrunks()`	The network components that are connected to this VLAN through a trunk.
`String`	`getNetworkSpace()`	Identifier to denote whether a VLAN is used for public or private connectivity.
`Firewall`	`getNetworkVlanFirewall()`	The Hardware Firewall (Dedicated) for a network vlan.
`Vlan`	`getObject()`	getObject retrieves the SoftLayer_Network_Vlan object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Vlan service.
`Router`	`getPrimaryRouter()`	The primary router that a VLAN is associated with.
`Subnet`	`getPrimarySubnet()`	A VLAN's primary subnet.
`List<Subnet>`	`getPrimarySubnets()`
`Subnet`	`getPrimarySubnetVersion6()`	A VLAN's primary IPv6 subnet.
`List<Gateway>`	`getPrivateNetworkGateways()`	The gateways this VLAN is the private VLAN of.
`Vlan`	`getPrivateVlan()`	Retrieve a VLAN's associated private network VLAN.
`Vlan`	`getPrivateVlanByIpAddress(String ipAddress)`	* DEPRECATED * Retrieve the private network VLAN associated with an IP address.
`List<IpAddress>`	`getProtectedIpAddresses()`
`List<Gateway>`	`getPublicNetworkGateways()`	The gateways this VLAN is the public VLAN of.
`Vlan`	`getPublicVlanByFqdn(String fqdn)`	Retrieve the VLAN that belongs to a server's public network interface, as described by a server's fully-qualified domain name.
`List<Domain>`	`getReverseDomainRecords()`	Retrieve all reverse DNS records associated with the subnets assigned to a VLAN.
`Boolean`	`getSanStorageCapabilityFlag()`	A flag indicating that a vlan can be assigned to a host that has SAN disk functionality.
`List<Vlan>`	`getScaleVlans()`	Collection of scale VLANs this VLAN applies to.
`Hardware`	`getSecondaryRouter()`	The secondary router that a VLAN is associated with.
`List<Subnet>`	`getSecondarySubnets()`	The subnets that exist as secondary interfaces on a VLAN
`List<Subnet>`	`getSubnets()`	All of the subnets that exist as VLAN interfaces.
`List<Reference>`	`getTagReferences()`	References to all tags for this VLAN.
`Long`	`getTotalPrimaryIpAddressCount()`	The number of primary IP addresses in a VLAN.
`Type`	`getType()`	The type of this VLAN.
`List<Guest>`	`getVirtualGuests()`	All of the Virtual Servers that are connected to a VLAN.
`Vlan`	`getVlanForIpAddress(String ipAddress)`	Retrieve the VLAN associated with an IP address via the IP's associated subnet.
`void`	`setMask(Vlan.Mask mask)`
`Boolean`	`setTags(String tags)`	Tag a VLAN by passing in one or more tags separated by a comma.
`Void`	`updateFirewallIntraVlanCommunication(Boolean enabled)`	The '''getSensorData''' method updates a VLAN's firewall to allow or disallow intra-VLAN communication.
`Vlan`	`upgrade()`	Convert the VLAN this operation is executed against to a paid resource.
`Vlan.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Vlan.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Vlan.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Vlan.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Vlan.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Vlan.Mask mask)
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Vlan templateObject)
  
  Edit a VLAN's properties
  
  See Also:
  
  SoftLayer_Network_Vlan::editObject
- getCancelFailureReasons
  
  @ApiMethod(instanceRequired=true) List<String> getCancelFailureReasons()
  
  Get a set of reasons why this VLAN may not be cancelled. If the result is empty, this VLAN may be cancelled.
  
  See Also:
  
  SoftLayer_Network_Vlan::getCancelFailureReasons
- getFirewallProtectableIpAddresses
  
  @ApiMethod(instanceRequired=true) List<IpAddress> getFirewallProtectableIpAddresses()
  
  Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this VLAN. Please use getFirewallProtectableSubnets to get all protectable subnets.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallProtectableIpAddresses
- getFirewallProtectableSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getFirewallProtectableSubnets()
  
  Get the subnets associated with this server that are protectable by a network component firewall.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallProtectableSubnets
- getObject
  
  @ApiMethod(instanceRequired=true) Vlan getObject()
  
  getObject retrieves the SoftLayer_Network_Vlan object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Vlan service. You can only retrieve VLANs that are associated with your SoftLayer customer account.
  
  See Also:
  
  SoftLayer_Network_Vlan::getObject
- getPrivateVlan
  
  @ApiMethod(instanceRequired=true) Vlan getPrivateVlan()
  
  Retrieve a VLAN's associated private network VLAN. getPrivateVlan gathers it's information by retrieving the private VLAN of a VLAN's primary hardware object.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrivateVlan
- getPrivateVlanByIpAddress
  
  @ApiMethod Vlan getPrivateVlanByIpAddress(String ipAddress)
  
  *** DEPRECATED ***
  Retrieve the private network VLAN associated with an IP address.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrivateVlanByIpAddress
- getPublicVlanByFqdn
  
  @ApiMethod Vlan getPublicVlanByFqdn(String fqdn)
  
  Retrieve the VLAN that belongs to a server's public network interface, as described by a server's fully-qualified domain name. A server's ''FQDN'' is it's hostname, followed by a period then it's domain name.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPublicVlanByFqdn
- getReverseDomainRecords
  
  @ApiMethod(instanceRequired=true) List<Domain> getReverseDomainRecords()
  
  Retrieve all reverse DNS records associated with the subnets assigned to a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getReverseDomainRecords
- getVlanForIpAddress
  
  @ApiMethod Vlan getVlanForIpAddress(String ipAddress)
  
  Retrieve the VLAN associated with an IP address via the IP's associated subnet.
  
  See Also:
  
  SoftLayer_Network_Vlan::getVlanForIpAddress
- setTags
  
  @ApiMethod(instanceRequired=true) Boolean setTags(String tags)
  
  Tag a VLAN by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your VLAN is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list.
  
  See Also:
  
  SoftLayer_Network_Vlan::setTags
- updateFirewallIntraVlanCommunication
  
  @ApiMethod(instanceRequired=true) Void updateFirewallIntraVlanCommunication(Boolean enabled)
  
  The '''getSensorData''' method updates a VLAN's firewall to allow or disallow intra-VLAN communication.
  
  See Also:
  
  SoftLayer_Network_Vlan::updateFirewallIntraVlanCommunication
- upgrade
  
  @ApiMethod(instanceRequired=true) Vlan upgrade()
  
  Convert the VLAN this operation is executed against to a paid resource. This can be done for any Automatic VLAN. This operation can only be executed on an Automatic VLAN, and will transition it to being a Premium VLAN. The VLAN will then provide the benefits of a Premium VLAN. A Premium VLAN will remain on the account until cancelled. This operation cannot be undone! Once a VLAN becomes Premium, it can only be removed through cancellation, which will result in it being reclaimed.
  
  This operation is a convenience for utilizing the SoftLayer_Product_Order.placeOrder operation. It will place an order to upgrade the VLAN it is executed against. It will take a few moments for the order to be processed and the upgrade to complete. Note that the order is placed in such a way that any account state which prevents automatic order approval will prevent the order from being placed. Thus, if no error is received, the order was placed and approved, and the VLAN will be upgraded shortly.
  
  See Also:
  
  SoftLayer_Network_Vlan::upgrade
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The SoftLayer customer account associated with a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getAccount
- getAdditionalPrimarySubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getAdditionalPrimarySubnets()
  
  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.
  
  See Also:
  
  SoftLayer_Network_Vlan::getAdditionalPrimarySubnets
- getAttachedNetworkGateway
  
  @ApiMethod(instanceRequired=true) Gateway getAttachedNetworkGateway()
  
  The gateway this VLAN is inside of.
  
  See Also:
  
  SoftLayer_Network_Vlan::getAttachedNetworkGateway
- getAttachedNetworkGatewayFlag
  
  @ApiMethod(instanceRequired=true) Boolean getAttachedNetworkGatewayFlag()
  
  Whether or not this VLAN is inside a gateway.
  
  See Also:
  
  SoftLayer_Network_Vlan::getAttachedNetworkGatewayFlag
- getAttachedNetworkGatewayVlan
  
  @ApiMethod(instanceRequired=true) Vlan getAttachedNetworkGatewayVlan()
  
  The inside VLAN record if this VLAN is inside a network gateway.
  
  See Also:
  
  SoftLayer_Network_Vlan::getAttachedNetworkGatewayVlan
- getBillingItem
  
  @ApiMethod(instanceRequired=true) Item getBillingItem()
  
  The billing item for a network vlan.
  
  See Also:
  
  SoftLayer_Network_Vlan::getBillingItem
- getDedicatedFirewallFlag
  
  @ApiMethod(instanceRequired=true) Long getDedicatedFirewallFlag()
  
  A flag indicating that a network vlan is on a Hardware Firewall (Dedicated).
  
  See Also:
  
  SoftLayer_Network_Vlan::getDedicatedFirewallFlag
- getExtensionRouter
  
  @ApiMethod(instanceRequired=true) Router getExtensionRouter()
  
  The extension router that a VLAN is associated with.
  
  See Also:
  
  SoftLayer_Network_Vlan::getExtensionRouter
- getFirewallGuestNetworkComponents
  
  @ApiMethod(instanceRequired=true) List<Firewall> getFirewallGuestNetworkComponents()
  
  A firewalled Vlan's network components.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallGuestNetworkComponents
- getFirewallInterfaces
  
  @ApiMethod(instanceRequired=true) List<Interface> getFirewallInterfaces()
  
  A firewalled vlan's inbound/outbound interfaces.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallInterfaces
- getFirewallNetworkComponents
  
  @ApiMethod(instanceRequired=true) List<Firewall> getFirewallNetworkComponents()
  
  A firewalled Vlan's network components.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallNetworkComponents
- getFirewallRules
  
  @ApiMethod(instanceRequired=true) List<Rule> getFirewallRules()
  
  The currently running rule set of a firewalled VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getFirewallRules
- getGuestNetworkComponents
  
  @ApiMethod(instanceRequired=true) List<Component> getGuestNetworkComponents()
  
  The networking components that are connected to a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getGuestNetworkComponents
- getHardware
  
  @ApiMethod(instanceRequired=true) List<Hardware> getHardware()
  
  All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components.
  
  See Also:
  
  SoftLayer_Network_Vlan::getHardware
- getHighAvailabilityFirewallFlag
  
  @ApiMethod(instanceRequired=true) Boolean getHighAvailabilityFirewallFlag()
  
  See Also:
  
  SoftLayer_Network_Vlan::getHighAvailabilityFirewallFlag
- getLocalDiskStorageCapabilityFlag
  
  @ApiMethod(instanceRequired=true) Boolean getLocalDiskStorageCapabilityFlag()
  
  A flag indicating that a vlan can be assigned to a host that has local disk functionality.
  
  See Also:
  
  SoftLayer_Network_Vlan::getLocalDiskStorageCapabilityFlag
- getNetwork
  
  @ApiMethod(instanceRequired=true) Network getNetwork()
  
  The network in which this VLAN resides.
  
  See Also:
  
  SoftLayer_Network_Vlan::getNetwork
- getNetworkComponentTrunks
  
  @ApiMethod(instanceRequired=true) List<Trunk> getNetworkComponentTrunks()
  
  The network components that are connected to this VLAN through a trunk.
  
  See Also:
  
  SoftLayer_Network_Vlan::getNetworkComponentTrunks
- getNetworkComponents
  
  @ApiMethod(instanceRequired=true) List<Component> getNetworkComponents()
  
  The networking components that are connected to a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getNetworkComponents
- getNetworkSpace
  
  @ApiMethod(instanceRequired=true) String getNetworkSpace()
  
  Identifier to denote whether a VLAN is used for public or private connectivity.
  
  See Also:
  
  SoftLayer_Network_Vlan::getNetworkSpace
- getNetworkVlanFirewall
  
  @ApiMethod(instanceRequired=true) Firewall getNetworkVlanFirewall()
  
  The Hardware Firewall (Dedicated) for a network vlan.
  
  See Also:
  
  SoftLayer_Network_Vlan::getNetworkVlanFirewall
- getPrimaryRouter
  
  @ApiMethod(instanceRequired=true) Router getPrimaryRouter()
  
  The primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrimaryRouter
- getPrimarySubnet
  
  @ApiMethod(instanceRequired=true) Subnet getPrimarySubnet()
  
  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.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrimarySubnet
- getPrimarySubnetVersion6
  
  @ApiMethod(instanceRequired=true) Subnet getPrimarySubnetVersion6()
  
  A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrimarySubnetVersion6
- getPrimarySubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getPrimarySubnets()
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrimarySubnets
- getPrivateNetworkGateways
  
  @ApiMethod(instanceRequired=true) List<Gateway> getPrivateNetworkGateways()
  
  The gateways this VLAN is the private VLAN of.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPrivateNetworkGateways
- getProtectedIpAddresses
  
  @ApiMethod(instanceRequired=true) List<IpAddress> getProtectedIpAddresses()
  
  See Also:
  
  SoftLayer_Network_Vlan::getProtectedIpAddresses
- getPublicNetworkGateways
  
  @ApiMethod(instanceRequired=true) List<Gateway> getPublicNetworkGateways()
  
  The gateways this VLAN is the public VLAN of.
  
  See Also:
  
  SoftLayer_Network_Vlan::getPublicNetworkGateways
- getSanStorageCapabilityFlag
  
  @ApiMethod(instanceRequired=true) Boolean getSanStorageCapabilityFlag()
  
  A flag indicating that a vlan can be assigned to a host that has SAN disk functionality.
  
  See Also:
  
  SoftLayer_Network_Vlan::getSanStorageCapabilityFlag
- getScaleVlans
  
  @ApiMethod(instanceRequired=true) List<Vlan> getScaleVlans()
  
  Collection of scale VLANs this VLAN applies to.
  
  See Also:
  
  SoftLayer_Network_Vlan::getScaleVlans
- getSecondaryRouter
  
  @ApiMethod(instanceRequired=true) Hardware getSecondaryRouter()
  
  The secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.
  
  See Also:
  
  SoftLayer_Network_Vlan::getSecondaryRouter
- getSecondarySubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getSecondarySubnets()
  
  The subnets that exist as secondary interfaces on a VLAN
  
  See Also:
  
  SoftLayer_Network_Vlan::getSecondarySubnets
- getSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getSubnets()
  
  All of the subnets that exist as VLAN interfaces.
  
  See Also:
  
  SoftLayer_Network_Vlan::getSubnets
- getTagReferences
  
  @ApiMethod(instanceRequired=true) List<Reference> getTagReferences()
  
  References to all tags for this VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getTagReferences
- getTotalPrimaryIpAddressCount
  
  @ApiMethod(instanceRequired=true) Long getTotalPrimaryIpAddressCount()
  
  The number of primary IP addresses in a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getTotalPrimaryIpAddressCount
- getType
  
  @ApiMethod(instanceRequired=true) Type getType()
  
  The type of this VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getType
- getVirtualGuests
  
  @ApiMethod(instanceRequired=true) List<Guest> getVirtualGuests()
  
  All of the Virtual Servers that are connected to a VLAN.
  
  See Also:
  
  SoftLayer_Network_Vlan::getVirtualGuests

Interface Vlan.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details