com.solidfire.element.api

Class TestPingRequest

java.lang.Object

com.solidfire.element.api.TestPingRequest

All Implemented Interfaces:

java.io.Serializable

public class TestPingRequest
extends java.lang.Object
implements java.io.Serializable

TestPingRequest The TestPing API allows to test the reachability to IP address(s) using ICMP packets. Source address(v4 or v6), interface and vlan tag can be specified. If not Bond1G/10G network is used to reach the target address. The test uses the appropriate MTU sizes for each packet based on the MTU settings in the network configuration. Note: This method is available only through the per-node API endpoint 5.0 or later.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestPingRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
TestPingRequest()
TestPingRequest(Optional<java.lang.Long> attempts, Optional<java.lang.String> hosts, Optional<java.lang.Long> totalTimeoutSec, Optional<java.lang.Long> packetSize, Optional<java.lang.Long> pingTimeoutMsec, Optional<java.lang.Boolean> prohibitFragmentation, Optional<java.lang.String> sourceAddressV4, Optional<java.lang.String> sourceAddressV6, Optional<java.lang.String> iface, Optional<java.lang.Long> virtualNetworkTag)

Method Summary

Modifier and Type	Method and Description
TestPingRequest.Builder	asBuilder()
static TestPingRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Long>	getAttempts() Specifies the number of times the system should repeat the test ping.
Optional<java.lang.String>	getHosts() Specifies a comma-separated list of addresses or hostnames of devices to ping.
Optional<java.lang.String>	getIface() Existing interface on which the temporary vlan interface is created
Optional<java.lang.Long>	getPacketSize() Specifies the number of bytes to send in the ICMP packet that is sent to each IP.
Optional<java.lang.Long>	getPingTimeoutMsec() Specifies the number of milliseconds to wait for each individual ping response.
Optional<java.lang.Boolean>	getProhibitFragmentation() Specifies that the Do not Fragment (DF) flag is enabled for the ICMP packets.
Optional<java.lang.String>	getSourceAddressV4() The ipv4 source address to be used in the ICMP ping packets sourceAddressV4 or sourceAddressV6 is required
Optional<java.lang.String>	getSourceAddressV6() The ipv6 source address to be used in the ICMP ping packets sourceAddressV4 or sourceAddressV6 is required
Optional<java.lang.Long>	getTotalTimeoutSec() Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process.
Optional<java.lang.Long>	getVirtualNetworkTag() VLAN on which host addresses reachability needs to be tested The temporary vlan interface is created with this tag
int	hashCode()
void	setAttempts(Optional<java.lang.Long> attempts)
void	setHosts(Optional<java.lang.String> hosts)
void	setIface(Optional<java.lang.String> iface)
void	setPacketSize(Optional<java.lang.Long> packetSize)
void	setPingTimeoutMsec(Optional<java.lang.Long> pingTimeoutMsec)
void	setProhibitFragmentation(Optional<java.lang.Boolean> prohibitFragmentation)
void	setSourceAddressV4(Optional<java.lang.String> sourceAddressV4)
void	setSourceAddressV6(Optional<java.lang.String> sourceAddressV6)
void	setTotalTimeoutSec(Optional<java.lang.Long> totalTimeoutSec)
void	setVirtualNetworkTag(Optional<java.lang.Long> virtualNetworkTag)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TestPingRequest

@Since(value="7.0")
public TestPingRequest()

TestPingRequest

@Since(value="7.0")
public TestPingRequest(Optional<java.lang.Long> attempts,
                                           Optional<java.lang.String> hosts,
                                           Optional<java.lang.Long> totalTimeoutSec,
                                           Optional<java.lang.Long> packetSize,
                                           Optional<java.lang.Long> pingTimeoutMsec,
                                           Optional<java.lang.Boolean> prohibitFragmentation,
                                           Optional<java.lang.String> sourceAddressV4,
                                           Optional<java.lang.String> sourceAddressV6,
                                           Optional<java.lang.String> iface,
                                           Optional<java.lang.Long> virtualNetworkTag)

Method Detail

getAttempts

public Optional<java.lang.Long> getAttempts()

Specifies the number of times the system should repeat the test ping. The default value is 5.

setAttempts

public void setAttempts(Optional<java.lang.Long> attempts)

getHosts

public Optional<java.lang.String> getHosts()

Specifies a comma-separated list of addresses or hostnames of devices to ping.

setHosts

public void setHosts(Optional<java.lang.String> hosts)

getTotalTimeoutSec

public Optional<java.lang.Long> getTotalTimeoutSec()

Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process.

setTotalTimeoutSec

public void setTotalTimeoutSec(Optional<java.lang.Long> totalTimeoutSec)

getPacketSize

public Optional<java.lang.Long> getPacketSize()

Specifies the number of bytes to send in the ICMP packet that is sent to each IP. The number must be less than the maximum MTU specified in the network configuration.

setPacketSize

public void setPacketSize(Optional<java.lang.Long> packetSize)

getPingTimeoutMsec

public Optional<java.lang.Long> getPingTimeoutMsec()

Specifies the number of milliseconds to wait for each individual ping response. The default value is 500 ms.

setPingTimeoutMsec

public void setPingTimeoutMsec(Optional<java.lang.Long> pingTimeoutMsec)

getProhibitFragmentation

public Optional<java.lang.Boolean> getProhibitFragmentation()

Specifies that the Do not Fragment (DF) flag is enabled for the ICMP packets.

setProhibitFragmentation

public void setProhibitFragmentation(Optional<java.lang.Boolean> prohibitFragmentation)

getSourceAddressV4

public Optional<java.lang.String> getSourceAddressV4()

The ipv4 source address to be used in the ICMP ping packets sourceAddressV4 or sourceAddressV6 is required

setSourceAddressV4

public void setSourceAddressV4(Optional<java.lang.String> sourceAddressV4)

getSourceAddressV6

public Optional<java.lang.String> getSourceAddressV6()

The ipv6 source address to be used in the ICMP ping packets sourceAddressV4 or sourceAddressV6 is required

setSourceAddressV6

public void setSourceAddressV6(Optional<java.lang.String> sourceAddressV6)

getIface

public Optional<java.lang.String> getIface()

Existing interface on which the temporary vlan interface is created

setIface

public void setIface(Optional<java.lang.String> iface)

getVirtualNetworkTag

public Optional<java.lang.Long> getVirtualNetworkTag()

VLAN on which host addresses reachability needs to be tested The temporary vlan interface is created with this tag

setVirtualNetworkTag

public void setVirtualNetworkTag(Optional<java.lang.Long> virtualNetworkTag)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static TestPingRequest.Builder builder()

asBuilder

public final TestPingRequest.Builder asBuilder()