All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

IpAddress
```
@ApiService("SoftLayer_Network_Subnet_IpAddress")
public static interface IpAddress.Service
extends Service
```
Every SoftLayer IP address is defined in the SoftLayer_Network_Subnet_IpAddress service. SoftLayer IP addresses are assigned to a SoftLayer_Network_Subnet. The SoftLayer_Network_Subnet_IpAddress service gives you information about an IP address such if it is reserved, a network address, or a gateway. Use the data returned by these methods with other API services to get more detailed information about your services.

SoftLayer customers can order and manage IP addresses through the customer portal. If you need to cancel a subnet please open a sales ticket in our customer portal and our account management staff will assist you.

See Also:

SoftLayer_Network_Subnet_IpAddress

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Boolean`	`allowAccessToNetworkStorage(Storage networkStorageTemplateObject)`	This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
`Boolean`	`allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
`IpAddress.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`editObject(IpAddress templateObject)`	Edit a subnet IP address.
`Boolean`	`editObjects(List<IpAddress> templateObjects)`	This function is used to edit multiple objects at the same time.
`IpAddress`	`findByIpv4Address(String ipAddress)`	Search for an IP address record by IPv4 address.
`Host`	`getAllowedHost()`	The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.
`List<Storage>`	`getAllowedNetworkStorage()`	The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
`List<Storage>`	`getAllowedNetworkStorageReplicas()`	The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
`Controller`	`getApplicationDeliveryController()`	The application delivery controller using this address.
`List<Storage>`	`getAttachedNetworkStorages(String nasType)`	This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress.
`List<Storage>`	`getAvailableNetworkStorages(String nasType)`	This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress.
`IpAddress`	`getByIpAddress(String ipAddress)`	Search for an IP address record by IP address.
`List<Translation>`	`getContextTunnelTranslations()`	An IPSec network tunnel's address translations.
`List<Subnet>`	`getEndpointSubnets()`	All the subnets routed to an IP address.
`Component`	`getGuestNetworkComponent()`	A network component that is statically routed to an IP address.
`IpAddress`	`getGuestNetworkComponentBinding()`	A network component that is statically routed to an IP address.
`Hardware`	`getHardware()`	A server that this IP address is routed to.
`Component`	`getNetworkComponent()`	A network component that is statically routed to an IP address.
`IpAddress`	`getObject()`	getObject retrieves the SoftLayer_Network_Subnet_IpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_IpAddress service.
`Gateway`	`getPrivateNetworkGateway()`	The network gateway appliance using this address as the private IP address.
`List<Address>`	`getProtectionAddress()`
`Gateway`	`getPublicNetworkGateway()`	The network gateway appliance using this address as the public IP address.
`Component`	`getRemoteManagementNetworkComponent()`	An IPMI-based management network component of the IP address.
`Subnet`	`getSubnet()`	An IP address' associated subnet.
`List<Syslog>`	`getSyslogEventsOneDay()`	All events for this IP address stored in the datacenter syslogs from the last 24 hours
`List<Syslog>`	`getSyslogEventsSevenDays()`	All events for this IP address stored in the datacenter syslogs from the last 7 days
`List<Syslog>`	`getTopTenSyslogEventsByDestinationPortOneDay()`	Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours
`List<Syslog>`	`getTopTenSyslogEventsByDestinationPortSevenDays()`	Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days
`List<Syslog>`	`getTopTenSyslogEventsByProtocolsOneDay()`	Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
`List<Syslog>`	`getTopTenSyslogEventsByProtocolsSevenDays()`	Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
`List<Syslog>`	`getTopTenSyslogEventsBySourceIpOneDay()`	Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours
`List<Syslog>`	`getTopTenSyslogEventsBySourceIpSevenDays()`	Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days
`List<Syslog>`	`getTopTenSyslogEventsBySourcePortOneDay()`	Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
`List<Syslog>`	`getTopTenSyslogEventsBySourcePortSevenDays()`	Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
`Guest`	`getVirtualGuest()`	A virtual guest that this IP address is routed to.
`List<VirtualLicense>`	`getVirtualLicenses()`	Virtual licenses allocated for an IP Address.
`Boolean`	`removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to remove access to multiple SoftLayer_Network_Storage volumes
`void`	`setMask(IpAddress.Mask mask)`
`IpAddress.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`IpAddress.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 Detail
  - asAsync
```
IpAddress.ServiceAsync asAsync()
```
    Description copied from interface: Service
    
    Get an async version of this service
    
    Specified by:
    
    asAsync in interface Service
  - withNewMask
```
IpAddress.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
```
IpAddress.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(IpAddress.Mask mask)
```
  - allowAccessToNetworkStorage
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject)
```
    This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::allowAccessToNetworkStorage
  - allowAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::allowAccessToNetworkStorageList
  - editObject
```
@ApiMethod(instanceRequired=true)
Boolean editObject(IpAddress templateObject)
```
    Edit a subnet IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::editObject
  - editObjects
```
@ApiMethod
Boolean editObjects(List<IpAddress> templateObjects)
```
    This function is used to edit multiple objects at the same time.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::editObjects
  - findByIpv4Address
```
@ApiMethod
IpAddress findByIpv4Address(String ipAddress)
```
    Search for an IP address record by IPv4 address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::findByIpv4Address
  - getAttachedNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAttachedNetworkStorages(String nasType)
```
    This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getAttachedNetworkStorages
  - getAvailableNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAvailableNetworkStorages(String nasType)
```
    This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getAvailableNetworkStorages
  - getByIpAddress
```
@ApiMethod
IpAddress getByIpAddress(String ipAddress)
```
    Search for an IP address record by IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getByIpAddress
  - getObject
```
@ApiMethod(instanceRequired=true)
IpAddress getObject()
```
    getObject retrieves the SoftLayer_Network_Subnet_IpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_IpAddress service. You can only retrieve the IP address whose subnet is associated with a VLAN that is associated with the account that your portal user is assigned to.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getObject
  - removeAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to remove access to multiple SoftLayer_Network_Storage volumes
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::removeAccessToNetworkStorageList
  - getAllowedHost
```
@ApiMethod(instanceRequired=true)
Host getAllowedHost()
```
    The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getAllowedHost
  - getAllowedNetworkStorage
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorage()
```
    The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getAllowedNetworkStorage
  - getAllowedNetworkStorageReplicas
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorageReplicas()
```
    The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getAllowedNetworkStorageReplicas
  - getApplicationDeliveryController
```
@ApiMethod(instanceRequired=true)
Controller getApplicationDeliveryController()
```
    The application delivery controller using this address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getApplicationDeliveryController
  - getContextTunnelTranslations
```
@ApiMethod(instanceRequired=true)
List<Translation> getContextTunnelTranslations()
```
    An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getContextTunnelTranslations
  - getEndpointSubnets
```
@ApiMethod(instanceRequired=true)
List<Subnet> getEndpointSubnets()
```
    All the subnets routed to an IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getEndpointSubnets
  - getGuestNetworkComponent
```
@ApiMethod(instanceRequired=true)
Component getGuestNetworkComponent()
```
    A network component that is statically routed to an IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getGuestNetworkComponent
  - getGuestNetworkComponentBinding
```
@ApiMethod(instanceRequired=true)
IpAddress getGuestNetworkComponentBinding()
```
    A network component that is statically routed to an IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getGuestNetworkComponentBinding
  - getHardware
```
@ApiMethod(instanceRequired=true)
Hardware getHardware()
```
    A server that this IP address is routed to.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getHardware
  - getNetworkComponent
```
@ApiMethod(instanceRequired=true)
Component getNetworkComponent()
```
    A network component that is statically routed to an IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getNetworkComponent
  - getPrivateNetworkGateway
```
@ApiMethod(instanceRequired=true)
Gateway getPrivateNetworkGateway()
```
    The network gateway appliance using this address as the private IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getPrivateNetworkGateway
  - getProtectionAddress
```
@ApiMethod(instanceRequired=true)
List<Address> getProtectionAddress()
```
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getProtectionAddress
  - getPublicNetworkGateway
```
@ApiMethod(instanceRequired=true)
Gateway getPublicNetworkGateway()
```
    The network gateway appliance using this address as the public IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getPublicNetworkGateway
  - getRemoteManagementNetworkComponent
```
@ApiMethod(instanceRequired=true)
Component getRemoteManagementNetworkComponent()
```
    An IPMI-based management network component of the IP address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getRemoteManagementNetworkComponent
  - getSubnet
```
@ApiMethod(instanceRequired=true)
Subnet getSubnet()
```
    An IP address' associated subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getSubnet
  - getSyslogEventsOneDay
```
@ApiMethod(instanceRequired=true)
List<Syslog> getSyslogEventsOneDay()
```
    All events for this IP address stored in the datacenter syslogs from the last 24 hours
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getSyslogEventsOneDay
  - getSyslogEventsSevenDays
```
@ApiMethod(instanceRequired=true)
List<Syslog> getSyslogEventsSevenDays()
```
    All events for this IP address stored in the datacenter syslogs from the last 7 days
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getSyslogEventsSevenDays
  - getTopTenSyslogEventsByDestinationPortOneDay
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsByDestinationPortOneDay()
```
    Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByDestinationPortOneDay
  - getTopTenSyslogEventsByDestinationPortSevenDays
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsByDestinationPortSevenDays()
```
    Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByDestinationPortSevenDays
  - getTopTenSyslogEventsByProtocolsOneDay
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsByProtocolsOneDay()
```
    Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByProtocolsOneDay
  - getTopTenSyslogEventsByProtocolsSevenDays
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsByProtocolsSevenDays()
```
    Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByProtocolsSevenDays
  - getTopTenSyslogEventsBySourceIpOneDay
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsBySourceIpOneDay()
```
    Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourceIpOneDay
  - getTopTenSyslogEventsBySourceIpSevenDays
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsBySourceIpSevenDays()
```
    Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourceIpSevenDays
  - getTopTenSyslogEventsBySourcePortOneDay
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsBySourcePortOneDay()
```
    Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourcePortOneDay
  - getTopTenSyslogEventsBySourcePortSevenDays
```
@ApiMethod(instanceRequired=true)
List<Syslog> getTopTenSyslogEventsBySourcePortSevenDays()
```
    Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourcePortSevenDays
  - getVirtualGuest
```
@ApiMethod(instanceRequired=true)
Guest getVirtualGuest()
```
    A virtual guest that this IP address is routed to.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getVirtualGuest
  - getVirtualLicenses
```
@ApiMethod(instanceRequired=true)
List<VirtualLicense> getVirtualLicenses()
```
    Virtual licenses allocated for an IP Address.
    
    See Also:
    
    SoftLayer_Network_Subnet_IpAddress::getVirtualLicenses

Interface IpAddress.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Detail

asAsync

withNewMask

withMask

setMask

allowAccessToNetworkStorage

allowAccessToNetworkStorageList

editObject

editObjects

findByIpv4Address

getAttachedNetworkStorages

getAvailableNetworkStorages

getByIpAddress

getObject

removeAccessToNetworkStorageList

getAllowedHost

getAllowedNetworkStorage

getAllowedNetworkStorageReplicas

getApplicationDeliveryController

getContextTunnelTranslations

getEndpointSubnets

getGuestNetworkComponent

getGuestNetworkComponentBinding

getHardware

getNetworkComponent

getPrivateNetworkGateway

getProtectionAddress

getPublicNetworkGateway

getRemoteManagementNetworkComponent

getSubnet

getSyslogEventsOneDay

getSyslogEventsSevenDays

getTopTenSyslogEventsByDestinationPortOneDay

getTopTenSyslogEventsByDestinationPortSevenDays

getTopTenSyslogEventsByProtocolsOneDay

getTopTenSyslogEventsByProtocolsSevenDays

getTopTenSyslogEventsBySourceIpOneDay

getTopTenSyslogEventsBySourceIpSevenDays

getTopTenSyslogEventsBySourcePortOneDay

getTopTenSyslogEventsBySourcePortSevenDays

getVirtualGuest

getVirtualLicenses