SoftLayer Network Subnet IpAddress (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Network_Subnet_IpAddress data type. For information on the SoftLayer_Network_Subnet_IpAddress service please see SoftLayer_Network_Subnet_IpAddress.

Contents 1 Overview 2 User Access 3 Local Properties 3.1 id 3.2 ipAddress 3.3 isBroadcast 3.4 isGateway 3.5 isNetwork 3.6 isReserved 3.7 note 3.8 subnetId 4 Relational Properties 4.1 endpointSubnets 4.2 hardware 4.3 networkComponent 4.4 remoteManagementNetworkComponent 4.5 subnet 4.6 syslogEventsOneDay 4.7 syslogEventsSevenDays 4.8 topTenSyslogEventsByDestinationPortOneDay 4.9 topTenSyslogEventsByDestinationPortSevenDays 4.10 topTenSyslogEventsByProtocolsOneDay 4.11 topTenSyslogEventsByProtocolsSevenDays 4.12 topTenSyslogEventsBySourceIpOneDay 4.13 topTenSyslogEventsBySourceIpSevenDays 4.14 topTenSyslogEventsBySourcePortOneDay 4.15 topTenSyslogEventsBySourcePortSevenDays 5 Count Properties 5.1 endpointSubnetCount 5.2 syslogEventsOneDayCount 5.3 syslogEventsSevenDayCount 5.4 topTenSyslogEventsByDestinationPortOneDayCount 5.5 topTenSyslogEventsByDestinationPortSevenDayCount 5.6 topTenSyslogEventsByProtocolsOneDayCount 5.7 topTenSyslogEventsByProtocolsSevenDayCount 5.8 topTenSyslogEventsBySourceIpOneDayCount 5.9 topTenSyslogEventsBySourceIpSevenDayCount 5.10 topTenSyslogEventsBySourcePortOneDayCount 5.11 topTenSyslogEventsBySourcePortSevenDayCount 6 Associated Methods

Overview

The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IP address.

User Access

Users wishing to access the SoftLayer_Network_Subnet_IpAddress type must have the View Hardware permission assigned to their account.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

id

An IP's internal identifier.

• Type: integer
• Permission: View Hardware

---

ipAddress

An IP address expressed in dotted quad format.

• Type: string
• Length: 39 characters
• Permission: View Hardware

---

isBroadcast

Indicates if an IP address is reserved to be used as the network broadcast address and cannot be assigned to a network interface

• Type: boolean
• Permission: View Hardware

---

isGateway

Indicates if an IP address is reserved to a gateway and cannot be assigned to a network interface

• Type: boolean
• Permission: View Hardware

---

isNetwork

Indicates if an IP address is reserved to a network address and cannot be assigned to a network interface

• Type: boolean
• Permission: View Hardware

---

isReserved

Indicates if an IP address is reserved and cannot be assigned to a network interface

• Type: boolean
• Permission: View Hardware

---

note

An IP address' user defined note.

• Type: string
• Length: 100 characters
• Permission: View Hardware

---

subnetId

An IP address' subnet id.

• Type: integer
• Length: 22 digits
• Permission: View Hardware

Relational Properties

endpointSubnets

All the subnets routed to an IP address.
endpointSubnets can be queried by object mask.

• Type: SoftLayer_Network_SubnetArray

---

hardware

A server that this IP address is routed to.
hardware can be queried by object mask.
hardware must be a unique value.

• Type: SoftLayer_Hardware

---

networkComponent

A network component that is statically routed to an IP address.
networkComponent can be queried by object mask.
networkComponent must be a unique value.

• Type: SoftLayer_Network_Component

---

remoteManagementNetworkComponent

An IPMI-based management network component of the IP address.
remoteManagementNetworkComponent can be queried by object mask.
remoteManagementNetworkComponent must be a unique value.

• Type: SoftLayer_Hardware

---

subnet

An IP address' associated subnet.
subnet can be queried by object mask.
subnet must be a unique value.

• Type: SoftLayer_Network_Subnet

---

syslogEventsOneDay

All events for this IP address stored in the datacenter syslogs from the last 24 hours
syslogEventsOneDay can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

syslogEventsSevenDays

All events for this IP address stored in the datacenter syslogs from the last 7 days
syslogEventsSevenDays can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsByDestinationPortOneDay

Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours
topTenSyslogEventsByDestinationPortOneDay can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsByDestinationPortSevenDays

Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days
topTenSyslogEventsByDestinationPortSevenDays can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsByProtocolsOneDay

Top Ten network datacenter syslog events, grouped by protocol, for the last 24 hours
topTenSyslogEventsByProtocolsOneDay can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsByProtocolsSevenDays

Top Ten network datacenter syslog events, grouped by protocol, for the last 7 days
topTenSyslogEventsByProtocolsSevenDays can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsBySourceIpOneDay

Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours
topTenSyslogEventsBySourceIpOneDay can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsBySourceIpSevenDays

Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days
topTenSyslogEventsBySourceIpSevenDays can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsBySourcePortOneDay

Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
topTenSyslogEventsBySourcePortOneDay can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

---

topTenSyslogEventsBySourcePortSevenDays

Top Ten network datacenter syslog events, grouped by source port, for the last 7 days
topTenSyslogEventsBySourcePortSevenDays can be queried by object mask.

• Type: SoftLayer_Network_Logging_SyslogArray

Count Properties

endpointSubnetCount

A count of all the subnets routed to an IP address.
endpointSubnetCount must be a unique value.

• Type: unsigned long

---

syslogEventsOneDayCount

A count of all events for this IP address stored in the datacenter syslogs from the last 24 hours
syslogEventsOneDayCount must be a unique value.

• Type: unsigned long

---

syslogEventsSevenDayCount

A count of all events for this IP address stored in the datacenter syslogs from the last 7 days
syslogEventsSevenDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsByDestinationPortOneDayCount

A count of top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours
topTenSyslogEventsByDestinationPortOneDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsByDestinationPortSevenDayCount

A count of top Ten network datacenter syslog events, grouped by destination port, for the last 7 days
topTenSyslogEventsByDestinationPortSevenDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsByProtocolsOneDayCount

A count of top Ten network datacenter syslog events, grouped by protocol, for the last 24 hours
topTenSyslogEventsByProtocolsOneDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsByProtocolsSevenDayCount

A count of top Ten network datacenter syslog events, grouped by protocol, for the last 7 days
topTenSyslogEventsByProtocolsSevenDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsBySourceIpOneDayCount

A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours
topTenSyslogEventsBySourceIpOneDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsBySourceIpSevenDayCount

A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days
topTenSyslogEventsBySourceIpSevenDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsBySourcePortOneDayCount

A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours
topTenSyslogEventsBySourcePortOneDayCount must be a unique value.

• Type: unsigned long

---

topTenSyslogEventsBySourcePortSevenDayCount

A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days
topTenSyslogEventsBySourcePortSevenDayCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Network_Subnet_IpAddress::getObject
• SoftLayer_Network_Subnet_IpAddress::editObject