SoftLayer_Network_Subnet


SoftLayer_Network_Subnet

Description

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.

Methods

allowAccessToNetworkStorage

Allow access to a SoftLayer_Network_Storage volume from this device.

allowAccessToNetworkStorageList

Allow access to multiple SoftLayer_Network_Storage volumes from this device.

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. …

createReverseDomainRecords

Create the default PTR records for this subnet

createSubnetRouteUpdateTransaction

create a new transaction to modify a subnet route.

createSwipTransaction

create a SWIP transaction for a subnet

editNote

Edit the note for this subnet.

findAllSubnetsAndActiveSwipTransactionStatus

Retrieve a list of subnets along with their SWIP transaction statuses.

getActiveRegistration

The active regional internet registration for this subnet.

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

The network storage devices and replicas this subnet has been granted access to.

getAvailableNetworkStorages

The network storage devices and replicas this subnet has NOT been granted access to. Only devices within the same datacenter as this subnet will be returned.

getBillingItem

The active billing item for this subnet.

getBoundRouterFlag

Indicates whether this subnet is associated to a network router and is routable on the network.

getBoundRouters

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.

getHardware

The Bare Metal devices which have been assigned a primary IP address from this subnet.

getIpAddressUsage

Retrieve IP address assignment details.

getIpAddresses

The IP address records belonging to this subnet.

getNetworkComponentFirewall

The hardware firewall associated to this subnet via access control list.

getNetworkTunnelContexts

The IPSec VPN tunnels associated to this subnet.

getNetworkVlan

The VLAN this subnet is associated with.

getObject

Retrieve a SoftLayer_Network_Subnet record.

getPodName

The pod in which this subnet is currently routed.

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

Retrieve IP addresses which may be used as a routing endpoint from a subnet.

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 an IP addresses’s associated subnet.

getSwipTransaction

DEPRECATED

getTagReferences

The tags associated to this subnet.

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 …

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.