org.opencord.cordvtn.impl

Class RemoteIpCommandUtil

java.lang.Object

org.opencord.cordvtn.impl.RemoteIpCommandUtil

public final class RemoteIpCommandUtil
extends Object

RemoteIpCommandUtil provides methods to help execute Linux IP commands to a remote server. It opens individual exec channels for each command. User can create a session with connect method and then execute a series commands. After done with all commands, the session must be closed explicitly by calling disconnect.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Method Summary

Modifier and Type	Method and Description
static boolean	addIp(com.jcraft.jsch.Session session, CidrAddr ip, String device) Adds a given IP address to a given device.
static com.jcraft.jsch.Session	connect(SshAccessInfo sshInfo) Creates a new session with a given access information.
static boolean	deleteIp(com.jcraft.jsch.Session session, org.onlab.packet.IpAddress ip, String device) Removes the IP address from a given device.
static void	disconnect(com.jcraft.jsch.Session session) Closes a connection.
static boolean	flushIp(com.jcraft.jsch.Session session, String device) Removes all IP address on a given device.
static Set<org.onlab.packet.IpAddress>	getCurrentIps(com.jcraft.jsch.Session session, String device) Returns a set of IP address that a given device has.
static boolean	isInterfaceUp(com.jcraft.jsch.Session session, String device) Checks if a given interface is up or not.
static boolean	setInterfaceUp(com.jcraft.jsch.Session session, String device) Sets link state up for a given device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

Method Detail

addIp

public static boolean addIp(com.jcraft.jsch.Session session,
                            CidrAddr ip,
                            String device)

Adds a given IP address to a given device.

Parameters:

session - ssh connection

ip - network address

device - device name to assign the ip address

Returns:

true if the command succeeds, or false

deleteIp

public static boolean deleteIp(com.jcraft.jsch.Session session,
                               org.onlab.packet.IpAddress ip,
                               String device)

Removes the IP address from a given device.

Parameters:

session - ssh connection

ip - ip address

device - device name

Returns:

true if the command succeeds, or false

flushIp

public static boolean flushIp(com.jcraft.jsch.Session session,
                              String device)

Removes all IP address on a given device.

Parameters:

session - ssh connection

device - device name

Returns:

true if the command succeeds, or false

getCurrentIps

public static Set<org.onlab.packet.IpAddress> getCurrentIps(com.jcraft.jsch.Session session,
                                                            String device)

Returns a set of IP address that a given device has.

Parameters:

session - ssh connection

device - device name

Returns:

set of IP prefix or empty set

setInterfaceUp

public static boolean setInterfaceUp(com.jcraft.jsch.Session session,
                                     String device)

Sets link state up for a given device.

Parameters:

session - ssh connection

device - device name

Returns:

true if the command succeeds, or false

isInterfaceUp

public static boolean isInterfaceUp(com.jcraft.jsch.Session session,
                                    String device)

Checks if a given interface is up or not.

Parameters:

session - ssh connection

device - device name

Returns:

true if the interface is up, or false

connect

public static com.jcraft.jsch.Session connect(SshAccessInfo sshInfo)

Creates a new session with a given access information.

Parameters:

sshInfo - information to ssh to the remove server

Returns:

ssh session, or null

disconnect

public static void disconnect(com.jcraft.jsch.Session session)

Closes a connection.

Parameters:

session - session