-
allowAccessToNetworkStorage
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
allowAccessToNetworkStorageList
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
-
clearRoute
This interface allows you to remove the route of your secondary subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later.
'''Important:''' When removing the route of ''Portable'' subnets, know that any subnet depending on an IP address provided by the Portable subnet will also have their routes removed!
To review what subnets are routed to IP addresses provided by a ''Portable'' subnet, you can utilize the following object mask: 'mask[ipAddresses[endpointSubnets]]'. Any subnet present in conjunction with ''endpointSubnets'' is a subnet which depends on the respective IP address.
The behavior of this interface is such that either true or false is returned. A result of false can be interpreted as the clear route request having already been completed. In contrast, a result of true means the subnet is currently routed and will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a clear route again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has been removed.
-
createReverseDomainRecords
Create the default PTR records for this subnet
-
createSubnetRouteUpdateTransaction
***DEPRECATED*** This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information.
Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute.
-
createSwipTransaction
***DEPRECATED*** This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses.
-
editNote
Edit the note for this subnet.
-
findAllSubnetsAndActiveSwipTransactionStatus
***DEPRECATED*** Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets' associated SWIP transactions as well.
This is a special function built for SoftLayer's use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data.
-
getAccount
-
getActiveRegistration
The active regional internet registration for this subnet.
-
getActiveSwipTransaction
DEPRECATED
-
getActiveTransaction
DEPRECATED
-
getAddressSpace
The classifier of IP addresses this subnet represents, generally PUBLIC or PRIVATE. This does not necessarily correlate with the network on which the subnet is used.
-
getAllowedHost
The link from this subnet to network storage devices supporting access control lists.
-
getAllowedNetworkStorage
The network storage devices this subnet has been granted access to.
-
getAllowedNetworkStorageReplicas
The network storage device replicas this subnet has been granted access to.
-
getAttachedNetworkStorages
Retrieves the combination of network storage devices and replicas this subnet has been granted access to. Allows for filtering based on storage device type.
-
getAvailableNetworkStorages
Retrieves the combination of network storage devices and replicas this subnet has NOT been granted access to. Allows for filtering based on storage device type.
-
getBillingItem
The active billing item for this subnet.
-
getBoundDescendants
-
getBoundRouterFlag
Indicates whether this subnet is associated to a network router and is routable on the network.
-
getBoundRouters
[DEPRECATED] The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.
-
getChildren
The immediate descendants of this subnet.
-
getDatacenter
The datacenter this subnet is primarily associated with.
-
getDescendants
The descendants of this subnet, including all parents and children.
-
getDisplayLabel
[DEPRECATED] The description of this subnet.
-
getEndPointIpAddress
The IP address target of this statically routed subnet.
-
getGlobalIpRecord
-
getHardware
The Bare Metal devices which have been assigned a primary IP address from this subnet.
-
getIpAddresses
The IP address records belonging to this subnet.
-
getIpAddressUsage
Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets.
Details on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data.
-
getNetworkComponentFirewall
The hardware firewall associated to this subnet via access control list.
-
getNetworkProtectionAddresses
-
getNetworkTunnelContexts
The IPSec VPN tunnels associated to this subnet.
-
getNetworkVlan
The VLAN this subnet is associated with.
-
getObject
Retrieves a subnet by its id value. Only subnets assigned to your account are accessible.
-
getPodName
The pod in which this subnet is currently routed.
-
getProtectedIpAddresses
-
getRegionalInternetRegistry
The RIR which is authoritative over the network in which this subnet resides.
-
getRegistrations
The regional internet registrations that have been created for this subnet.
-
getReverseDomain
The reverse DNS domain associated with this subnet.
-
getReverseDomainRecords
Retrieve all reverse DNS records associated with a subnet.
-
getRoleKeyName
The role identifier that this subnet is participating in. Roles dictate how a subnet may be used.
-
getRoleName
The name of the role the subnet is within. Roles dictate how a subnet may be used.
-
getRoutableEndpointIpAddresses
Returns IP addresses which may be used as routing endpoints for a given subnet. IP address which are currently the network, gateway, or broadcast address of a Secondary Portable subnet, are an address in a Secondary Static subnet, or if the address is not assigned to a resource when part of a Primary Subnet will not be available as a routing endpoint.
-
getRoutingTypeKeyName
The product and route classifier for this routed subnet, with the following values: PRIMARY, SECONDARY, STATIC_TO_IP, GLOBAL_IP, IPSEC_STATIC_NAT.
-
getRoutingTypeName
The description of the product and route classifier for this routed subnet, with the following values: Primary, Portable, Static, Global, IPSec Static NAT.
-
getSubnetForIpAddress
Retrieve the subnet associated with an IP address. You may only retrieve subnets assigned to your SoftLayer customer account.
-
getSwipTransaction
DEPRECATED
-
getTagReferences
The tags associated to this subnet.
-
getUnboundDescendants
-
getUtilizedIpAddressCount
The total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnets.
-
getVirtualGuests
The Virtual Server devices which have been assigned a primary IP address from this subnet.
-
removeAccessToNetworkStorageList
Removes access to multiple devices and replicas this subnet has been granted access to.
-
route
This interface allows you to change the route of your secondary subnets. It accommodates a number of ways to identify your desired routing destination through the use of a 'type' and 'identifier'. Subnets may be routed as either Static or Portable, and that designation is dictated by the routing destination specified.
Static subnets have an ultimate routing destination of a single IP address but may not be routed to an existing subnet's IP address whose subnet is routed as a Static. Portable subnets have an ultimate routing destination of a VLAN.
A subnet can be routed to any resource within the same 'routing region' as the subnet itself. A subnet's routing region can be diverse but is usually limited to a single data center.
The following identifier 'type' values will result in Static routing: <ul> <li>SoftLayer_Network_Subnet_IpAddress</li> <li>SoftLayer_Hardware_Server</li> <li>SoftLayer_Virtual_Guest</li> </ul>
The following identifier 'type' values will result in Portable routing: <ul> <li>SoftLayer_Network_Vlan</li> </ul>
For each identifier type, one or more 'identifier' formats are possible.
''SoftLayer_Network_Subnet_IpAddress'' will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Network_Subnet_IpAddress.id value of the desired IP address object.</li> <li>A dotted-quad IPv4 address.</li> <li>A full or compressed IPv6 address.</li> </ul>
''SoftLayer_Network_Vlan'' will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Network_Vlan.id value of the desired VLAN object.</li> <li>A semantic VLAN identifier of the form <data center short name>.<router>.<vlan number>, where < and > are literal, eg. dal13.fcr01.1234 - the router name may optionally contain the 'a' or 'b' redundancy qualifier (which has no meaning in this context).</li> </ul>
''SoftLayer_Hardware_Server'' will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Hardware_Server.id value of the desired server.</li> <li>A UUID corresponding to a server's SoftLayer_Hardware_Server.globalIdentifier.</li> <li>A value corresponding to a unique SoftLayer_Hardware_Server.hostname.</li> <li>A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, e.g. myhost<mydomain.com>, hostname refers to SoftLayer_Hardware_Server.hostname and domain to SoftLayer_Hardware_Server.domain, respectively.</li> </ul>
''SoftLayer_Virtual_Guest'' will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Virtual_Guest.id value of the desired server.</li> <li>A UUID corresponding to a server's SoftLayer_Virtual_Guest.globalIdentifier.</li> <li>A value corresponding to a unique SoftLayer_Virtual_Guest.hostname.</li> <li>A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, e.g. myhost<mydomain.com>, hostname refers to SoftLayer_Virtual_Guest.hostname and domain to SoftLayer_Virtual_Guest.domain, respectively.</li> </ul>
The routing destination result of specifying a SoftLayer_Hardware_Server or SoftLayer_Virtual_Guest type will be the primary IP address of the server for the same network segment the subnet is on. Thus, a public subnet will be routed to the server's public, primary IP address. Additionally, this IP address resolution will match the subnet's IP version; routing a IPv6 subnet to a server will result in selection of the primary IPv6 address of the respective network segment, if available.
Subnets may only be routed to the IP version they themselves represent. That means an IPv4 subnet can only be routed to IPv4 addresses. Any type/identifier combination that resolves to an IP address must be able to locate an IP address of the same version as the subnet being routed.
When routing to an IP address on a Primary subnet, only those addresses actively assigned to resources may be targeted. Additionally, the network, gateway, or broadcast address of any Portable subnet may not be a routing destination. For some VLANs utilizing the HSRP redundancy strategy, there are additional addresses which cannot be a route destination.
When routing a subnet that is already routed, note that the subnet first has its route removed; this procedure is the same as what will occur when using SoftLayer_Network_Subnet::clearRoute. Special consideration should be made for subnets routed as Portable. Please refer to the documentation for SoftLayer_Network_Subnet::clearRoute for details.
The behavior of this interface is such that either true or false is returned. A response of false indicates the route request would not result in the route of the subnet changing; attempts to route the subnet to the same destination, even if identified by differing means, will result in no changes. A result of false can be interpreted as the route request having already been completed. In contrast, a result of true means the requested destination is different from the current destination and the subnet's routing will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a route change again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has become the desired route destination.
Use of this operation is limited to a single active request per subnet. If a previous route request is not yet complete, a 'not ready' message will be returned upon subsequent requests.
-
setTags
Tag a subnet by passing in one or more tags separated by a comma. Any existing tags you wish to keep should be included in the set of tags, as any missing tags will be removed. To remove all tags from the subnet, send an empty string.
-
SoftLayer_Network_Subnet
A subnet represents a continguous range of IP addresses. The range is represented by the networkIdentifer and cidr/netmask properties. The version of a subnet, whether IPv4 or IPv6, is represented by the version property.
When routed, a subnet is associated to a VLAN on your account, which defines its scope on the network. Depending on a subnet's route type, IP addresses may be reserved for network and internal functions, the most common of which is the allocation of network, gateway and broadcast IP addresses.
An unrouted subnet is not active on the network and may generally be routed within the datacenter in which it resides.
[Subnetwork at Wikipedia](http://en.wikipedia.org/wiki/Subnetwork)
[RFC950:Internet Standard Subnetting Procedure](http://datatracker.ietf.org/doc/html/rfc950)
-
SoftLayer_Network_Subnet
This service enables interaction with subnets assigned to your account. IP addresses used on your network are drawn from your assigned subnets.
Primary subnets are assigned as needed and are reclaimed when no longer in use. Primary IP addresses assigned to your devices are drawn from your primary subnets, and the consumption of these IP addresses is tracked and discoverable herein.
Secondary subnets are assigned when ordered and are reclaimed when canceled. The consumption of IP addresses is not tracked.
Both IPv4 and IPv6 subnets are supported via this service.
Subnets can be tagged for discoverability and tracking purposes.