Interface IpAddress.Service
-
- 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 serviceBoolean
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 hoursList<Syslog>
getSyslogEventsSevenDays()
All events for this IP address stored in the datacenter syslogs from the last 7 daysList<Syslog>
getTopTenSyslogEventsByDestinationPortOneDay()
Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hoursList<Syslog>
getTopTenSyslogEventsByDestinationPortSevenDays()
Top Ten network datacenter syslog events, grouped by destination port, for the last 7 daysList<Syslog>
getTopTenSyslogEventsByProtocolsOneDay()
Top Ten network datacenter syslog events, grouped by source port, for the last 24 hoursList<Syslog>
getTopTenSyslogEventsByProtocolsSevenDays()
Top Ten network datacenter syslog events, grouped by source port, for the last 7 daysList<Syslog>
getTopTenSyslogEventsBySourceIpOneDay()
Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hoursList<Syslog>
getTopTenSyslogEventsBySourceIpSevenDays()
Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 daysList<Syslog>
getTopTenSyslogEventsBySourcePortOneDay()
Top Ten network datacenter syslog events, grouped by source port, for the last 24 hoursList<Syslog>
getTopTenSyslogEventsBySourcePortSevenDays()
Top Ten network datacenter syslog events, grouped by source port, for the last 7 daysGuest
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 volumesvoid
setMask(IpAddress.Mask mask)
IpAddress.Mask
withMask()
Use the existing mask on this service or create it if not presentIpAddress.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
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
-
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 interfaceMaskable
-
withMask
IpAddress.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
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.
-
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.
-
editObject
@ApiMethod(instanceRequired=true) Boolean editObject(IpAddress templateObject)
Edit a subnet IP address.
-
editObjects
@ApiMethod Boolean editObjects(List<IpAddress> templateObjects)
This function is used to edit multiple objects at the same time.
-
findByIpv4Address
@ApiMethod IpAddress findByIpv4Address(String ipAddress)
Search for an IP address record by IPv4 address.
-
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.
-
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.
-
getByIpAddress
@ApiMethod IpAddress getByIpAddress(String ipAddress)
Search for an IP address record by IP address.
-
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.
-
removeAccessToNetworkStorageList
@ApiMethod(instanceRequired=true) Boolean removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
This method is used to remove access to multiple SoftLayer_Network_Storage volumes
-
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.
-
getAllowedNetworkStorage
@ApiMethod(instanceRequired=true) List<Storage> getAllowedNetworkStorage()
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
@ApiMethod(instanceRequired=true) List<Storage> getAllowedNetworkStorageReplicas()
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getApplicationDeliveryController
@ApiMethod(instanceRequired=true) Controller getApplicationDeliveryController()
The application delivery controller using this address.
-
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.
-
getEndpointSubnets
@ApiMethod(instanceRequired=true) List<Subnet> getEndpointSubnets()
All the subnets routed to an IP address.
-
getGuestNetworkComponent
@ApiMethod(instanceRequired=true) Component getGuestNetworkComponent()
A network component that is statically routed to an IP address.
-
getGuestNetworkComponentBinding
@ApiMethod(instanceRequired=true) IpAddress getGuestNetworkComponentBinding()
A network component that is statically routed to an IP address.
-
getHardware
@ApiMethod(instanceRequired=true) Hardware getHardware()
A server that this IP address is routed to.
-
getNetworkComponent
@ApiMethod(instanceRequired=true) Component getNetworkComponent()
A network component that is statically routed to an IP address.
-
getPrivateNetworkGateway
@ApiMethod(instanceRequired=true) Gateway getPrivateNetworkGateway()
The network gateway appliance using this address as the private IP address.
-
getProtectionAddress
@ApiMethod(instanceRequired=true) List<Address> getProtectionAddress()
-
getPublicNetworkGateway
@ApiMethod(instanceRequired=true) Gateway getPublicNetworkGateway()
The network gateway appliance using this address as the public IP address.
-
getRemoteManagementNetworkComponent
@ApiMethod(instanceRequired=true) Component getRemoteManagementNetworkComponent()
An IPMI-based management network component of the IP address.
-
getSubnet
@ApiMethod(instanceRequired=true) Subnet getSubnet()
An IP address' associated subnet.
-
getSyslogEventsOneDay
@ApiMethod(instanceRequired=true) List<Syslog> getSyslogEventsOneDay()
All events for this IP address stored in the datacenter syslogs from the last 24 hours
-
getSyslogEventsSevenDays
@ApiMethod(instanceRequired=true) List<Syslog> getSyslogEventsSevenDays()
All events for this IP address stored in the datacenter syslogs from the last 7 days
-
getTopTenSyslogEventsByDestinationPortOneDay
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsByDestinationPortOneDay()
Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours
-
getTopTenSyslogEventsByDestinationPortSevenDays
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsByDestinationPortSevenDays()
Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days
-
getTopTenSyslogEventsByProtocolsOneDay
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsByProtocolsOneDay()
Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
-
getTopTenSyslogEventsByProtocolsSevenDays
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsByProtocolsSevenDays()
Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
-
getTopTenSyslogEventsBySourceIpOneDay
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsBySourceIpOneDay()
Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours
-
getTopTenSyslogEventsBySourceIpSevenDays
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsBySourceIpSevenDays()
Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days
-
getTopTenSyslogEventsBySourcePortOneDay
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsBySourcePortOneDay()
Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
-
getTopTenSyslogEventsBySourcePortSevenDays
@ApiMethod(instanceRequired=true) List<Syslog> getTopTenSyslogEventsBySourcePortSevenDays()
Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
-
getVirtualGuest
@ApiMethod(instanceRequired=true) Guest getVirtualGuest()
A virtual guest that this IP address is routed to.
-
getVirtualLicenses
@ApiMethod(instanceRequired=true) List<VirtualLicense> getVirtualLicenses()
Virtual licenses allocated for an IP Address.
-
-