![]() |
Open Kilda Java Documentation
|
Public Member Functions | |
ConnectModeRequest.Mode | connectMode (final ConnectModeRequest.Mode mode) |
void | installDefaultRules (final DatapathId dpid) throws SwitchOperationException |
void | installVerificationRule (final DatapathId dpid, final boolean isBroadcast) throws SwitchOperationException |
void | installDropFlow (final DatapathId dpid) throws SwitchOperationException |
void | installDropFlowCustom (final DatapathId dpid, String dstMac, String dstMask, final long cookie, final int priority) throws SwitchOperationException |
long | installIngressFlow (final DatapathId dpid, final String flowId, final Long cookie, final int inputPort, final int outputPort, final int inputVlanId, final int transitVlanId, final OutputVlanType outputVlanType, final long meterId) throws SwitchOperationException |
long | installEgressFlow (final DatapathId dpid, final String flowId, final Long cookie, final int inputPort, final int outputPort, final int transitVlanId, final int outputVlanId, final OutputVlanType outputVlanType) throws SwitchOperationException |
long | installTransitFlow (final DatapathId dpid, final String flowId, final Long cookie, final int inputPort, final int outputPort, final int transitVlanId) throws SwitchOperationException |
long | installOneSwitchFlow (final DatapathId dpid, final String flowId, final Long cookie, final int inputPort, final int outputPort, int inputVlanId, int outputVlanId, final OutputVlanType outputVlanType, final long meterId) throws SwitchOperationException |
List< OFFlowStatsEntry > | dumpFlowTable (final DatapathId dpid) |
OFMeterConfigStatsReply | dumpMeters (final DatapathId dpid) throws SwitchOperationException |
long | installMeter (final DatapathId dpid, final long bandwidth, final long burstSize, final long meterId) throws SwitchOperationException |
long | deleteMeter (final DatapathId dpid, final long meterId) throws SwitchOperationException |
Map< DatapathId, IOFSwitch > | getAllSwitchMap () |
List< Long > | deleteAllNonDefaultRules (DatapathId dpid) throws SwitchOperationException |
List< Long > | deleteDefaultRules (DatapathId dpid) throws SwitchOperationException |
List< Long > | deleteRulesByCriteria (DatapathId dpid, DeleteRulesCriteria... criteria) throws SwitchOperationException |
void | startSafeMode (final DatapathId dpid) throws SwitchOperationException |
void | stopSafeMode (final DatapathId dpid) |
void | safeModeTick () |
void | sendSwitchActivate (final IOFSwitch sw) throws SwitchOperationException |
void | sendPortUpEvents (final IOFSwitch sw) throws SwitchOperationException |
void | configurePort (DatapathId dpId, int portNumber, Boolean portAdminDown) throws SwitchOperationException |
Public Attributes | |
String | OVS_MANUFACTURER = "Nicira, Inc." |
long | DROP_RULE_COOKIE = 0x8000000000000001L |
long | VERIFICATION_BROADCAST_RULE_COOKIE = 0x8000000000000002L |
long | VERIFICATION_UNICAST_RULE_COOKIE = 0x8000000000000003L |
Definition at line 32 of file ISwitchManager.java.
void org.openkilda.floodlight.switchmanager.ISwitchManager.configurePort | ( | DatapathId | dpId, |
int | portNumber, | ||
Boolean | portAdminDown | ||
) | throws SwitchOperationException |
Configure switch port.
Configurations
dpId | datapath ID of the switch. |
portNumber | the port to configure. |
portAdminDown | the port status to be applied. |
SwitchOperationException | Switch not found or Port not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
ConnectModeRequest.Mode org.openkilda.floodlight.switchmanager.ISwitchManager.connectMode | ( | final ConnectModeRequest.Mode | mode | ) |
Set connection mode.
mode | the mode to use, if not null |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
List<Long> org.openkilda.floodlight.switchmanager.ISwitchManager.deleteAllNonDefaultRules | ( | DatapathId | dpid | ) | throws SwitchOperationException |
Deletes all non-default rules from the switch.
dpid | datapath ID of the switch |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
List<Long> org.openkilda.floodlight.switchmanager.ISwitchManager.deleteDefaultRules | ( | DatapathId | dpid | ) | throws SwitchOperationException |
Deletes the default rules (drop + verification) from the switch.
dpid | datapath ID of the switch |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.deleteMeter | ( | final DatapathId | dpid, |
final long | meterId | ||
) | throws SwitchOperationException |
Deletes the meter from the switch OF_13.
dpid | datapath ID of the switch |
meterId | meter identifier |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
List<Long> org.openkilda.floodlight.switchmanager.ISwitchManager.deleteRulesByCriteria | ( | DatapathId | dpid, |
DeleteRulesCriteria... | criteria | ||
) | throws SwitchOperationException |
Delete rules that match the criteria.
dpid | datapath ID of the switch |
criteria | the list of delete criteria |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
List<OFFlowStatsEntry> org.openkilda.floodlight.switchmanager.ISwitchManager.dumpFlowTable | ( | final DatapathId | dpid | ) |
Returns list of installed flows.
dpid | switch id |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
OFMeterConfigStatsReply org.openkilda.floodlight.switchmanager.ISwitchManager.dumpMeters | ( | final DatapathId | dpid | ) | throws SwitchOperationException |
Returns list of installed meters.
dpid | switch id |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
Map<DatapathId, IOFSwitch> org.openkilda.floodlight.switchmanager.ISwitchManager.getAllSwitchMap | ( | ) |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.installDefaultRules | ( | final DatapathId | dpid | ) | throws SwitchOperationException |
Adds default rules to install verification rules and final drop rule. Essentially, it calls installDropFlow and installVerificationRule twice (ie isBroadcast)
dpid | datapathId of switch |
SwitchOperationException | in case of errors |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.installDropFlow | ( | final DatapathId | dpid | ) | throws SwitchOperationException |
Installs the default drop rule.
dpid | datapathId of switch |
SwitchOperationException | in case of errors |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.installDropFlowCustom | ( | final DatapathId | dpid, |
String | dstMac, | ||
String | dstMask, | ||
final long | cookie, | ||
final int | priority | ||
) | throws SwitchOperationException |
Installs custom drop rule .. ie cookie, priority, match
dpid | datapathId of switch |
dstMac | Destination Mac address to match on |
dstMask | Destination Mask to match on |
cookie | Cookie to use for this rule |
priority | Priority of the rule |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.installEgressFlow | ( | final DatapathId | dpid, |
final String | flowId, | ||
final Long | cookie, | ||
final int | inputPort, | ||
final int | outputPort, | ||
final int | transitVlanId, | ||
final int | outputVlanId, | ||
final OutputVlanType | outputVlanType | ||
) | throws SwitchOperationException |
Installs flow on egress swtich.
dpid | datapathId of the switch |
flowId | flow id |
inputPort | port to expect the packet on |
outputPort | port to forward the packet out |
transitVlanId | vlan to match on the ingressPort |
outputVlanId | set vlan on packet before forwarding via outputPort; 0 means not to set |
outputVlanType | type of action to apply to the outputVlanId if greater than 0 |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.installIngressFlow | ( | final DatapathId | dpid, |
final String | flowId, | ||
final Long | cookie, | ||
final int | inputPort, | ||
final int | outputPort, | ||
final int | inputVlanId, | ||
final int | transitVlanId, | ||
final OutputVlanType | outputVlanType, | ||
final long | meterId | ||
) | throws SwitchOperationException |
Installs an flow on ingress switch.
dpid | datapathId of the switch |
flowId | flow id |
inputPort | port to expect the packet on |
outputPort | port to forward the packet out |
inputVlanId | input vlan to match on, 0 means not to match on vlan |
transitVlanId | vlan to add before outputing on outputPort |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.installMeter | ( | final DatapathId | dpid, |
final long | bandwidth, | ||
final long | burstSize, | ||
final long | meterId | ||
) | throws SwitchOperationException |
Installs a meter on ingress switch OF_13. TODO: describe params meaning in accordance with OF
dpid | datapath ID of the switch |
bandwidth | the bandwidth limit value |
burstSize | the size of the burst |
meterId | the meter ID |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.installOneSwitchFlow | ( | final DatapathId | dpid, |
final String | flowId, | ||
final Long | cookie, | ||
final int | inputPort, | ||
final int | outputPort, | ||
int | inputVlanId, | ||
int | outputVlanId, | ||
final OutputVlanType | outputVlanType, | ||
final long | meterId | ||
) | throws SwitchOperationException |
Installs flow through one switch.
dpid | datapathId of the switch |
flowId | flow id |
inputPort | port to expect packet on |
outputPort | port to forward packet out |
inputVlanId | vlan to match on inputPort |
outputVlanId | set vlan on packet before forwarding via outputPort; 0 means not to set |
outputVlanType | type of action to apply to the outputVlanId if greater than 0 |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.installTransitFlow | ( | final DatapathId | dpid, |
final String | flowId, | ||
final Long | cookie, | ||
final int | inputPort, | ||
final int | outputPort, | ||
final int | transitVlanId | ||
) | throws SwitchOperationException |
Installs flow on a transit switch.
dpid | datapathId of the switch |
flowId | flow id |
inputPort | port to expect packet on |
outputPort | port to forward packet out |
transitVlanId | vlan to match on inputPort |
SwitchOperationException | Switch not found |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.installVerificationRule | ( | final DatapathId | dpid, |
final boolean | isBroadcast | ||
) | throws SwitchOperationException |
Installs the default verification rule, if it is allowed. One case where it isn't - if the switch is an OpenFlow 1.2 switch and isBroadcast = false. In that scenario, nothing happens.
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.safeModeTick | ( | ) |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.sendPortUpEvents | ( | final IOFSwitch | sw | ) | throws SwitchOperationException |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.sendSwitchActivate | ( | final IOFSwitch | sw | ) | throws SwitchOperationException |
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.startSafeMode | ( | final DatapathId | dpid | ) | throws SwitchOperationException |
Safely install default rules - ie monitor traffic.
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
void org.openkilda.floodlight.switchmanager.ISwitchManager.stopSafeMode | ( | final DatapathId | dpid | ) |
Stop the safe install .. switch is deactivated or removed.
Implemented in org.openkilda.floodlight.switchmanager.SwitchManager.
long org.openkilda.floodlight.switchmanager.ISwitchManager.DROP_RULE_COOKIE = 0x8000000000000001L |
Definition at line 35 of file ISwitchManager.java.
String org.openkilda.floodlight.switchmanager.ISwitchManager.OVS_MANUFACTURER = "Nicira, Inc." |
OVS software switch manufacturer constant value.
Definition at line 34 of file ISwitchManager.java.
long org.openkilda.floodlight.switchmanager.ISwitchManager.VERIFICATION_BROADCAST_RULE_COOKIE = 0x8000000000000002L |
Definition at line 36 of file ISwitchManager.java.
long org.openkilda.floodlight.switchmanager.ISwitchManager.VERIFICATION_UNICAST_RULE_COOKIE = 0x8000000000000003L |
Definition at line 37 of file ISwitchManager.java.