TYPE | Description | SERVICES | APIs |
APP_READ | Permission to read various information about installed applications | Application Service | getApplication(s) getState getId getPermissions |
Core Service | version getAppId(s) | ||
APP_EVENT | Permission to receive application lifecycle events | Application Service | addListener removeListener |
CONFIG_READ | Permission to read configuration properties | Component Config Service | getComponentNames getProperties |
CONFIG_WRITE | Permission to write configuration properties | Component Config Service | registerProperties unregisterProperties setProperty unsetProperty |
CLUSTER_READ | Permission to read cluster information | Cluster Service | getLocalNode getNodes getState getLastUpdated |
Leadership Service | getLeader getLeadership ownedTopics getLeaderboard getCandidates | ||
Mastership Service | getLocalRole getMasterFor getNodesFor getDevicesOf | ||
CLUSTER_WRITE | Permission to modify the cluster | Leadership Service | runForLeadership withdraw |
Mastership Service | requestRoleFor relinquishMastership | ||
CLUSTER_EVENT | Permission receive cluster events | Cluster Service | addListener removeListener |
Leadership Service | addListener removeListener | ||
Mastership Service | addListener removeListener | ||
DEVICE_READ | Permission to read device information | Device Service | getDeviceCount getDevices getAvailableDevices getDevice getRole getPort(s) getPortStatistics isAvailable |
Device Clock Service | isTimestampAvailable getTimestamp | ||
DEVICE_EVENT | Permission receive device events | Device Service | addListener removeListener |
DRIVER_READ | Permission to get driver instances | Driver Service | getDriver(s) |
DRIVER_WRITE | Permission to create a new driver handler | Driver Service | createHandler |
FLOWRULE_READ | Permission to read flow rule information | Flow Rule Service | getFlowRuleCount getFlowEntries getFlowRulesById getFlowRulesByGroupId |
FLOWRULE_WRITE | Permission to add/remove flow rules | Flow Rule Service | applyFlowRules removeFlowRules removeFlowRulesById apply |
FlowObjectiveService | filter forward next allocateNextId | ||
FLOWRULE_EVENT | Permission receive flow rule events | Flow Rule Service | addListener removeListener |
GROUP_READ | Permission to read group information | Group Service | getGroup(s) |
GROUP_WRITE | Permission to modify groups | Group Service | addGroup addBucketsToGroup removeBucketsFromGroup removeGroup |
GROUP_EVENT | Permission to receive group events |
| addListener removeListener |
HOST_READ | Permission to read host information | Host Service | getHostCount getHosts getHost getHostByVlan getHostsByMac getHostsByIP getConnectedHosts getAddressBindings getAddressBindingsForPort |
Host Clock Service | getTimestemp | ||
HOST_WRITE | Permission to modify host | Host Service | requestMac |
HOST_EVENT | Permission receive host events | Host Service | startMonitoringIp stopMonitoringIp addListener removeListener |
INTENT_READ | Permission to read intent information | Intent Service | getIntent(s) getIntentCount getIntentState getInstallableIntents isLocal getPending |
Partition Service | isMine getLeader | ||
Intent Clock Service | getTimestamp | ||
INTENT_WRITE | Permission to add/remove intents | Intent Service | submit withdraw purge |
INTENT_EVENT | Permission receive intent events | Intent Service | addListener removeListener |
LINK_READ | Permission to read link information | Link Service | getLinkCount getLink(s) getActiveLinks getDeviceLinks getDeviceEgressLinks getEgressLinks getDeviceIngressLinks getIngressLinks |
Link Resource Service | getAllocation(s) getAvailableResources | ||
Label Resource Service | isDevicePoolFull isGlobalPoolFull getFreeNumOfDevicePool getFreeNumOfGlobalPool getDeviceLabelResourcePool getGlobalLabelResourcePool | ||
LINK_WRITE | Permission to modify link information | Link Resource Service | requestResources releaseResources updateResources |
Label Resource Service | applyFromDevicePool applyFromGlobalPool releaseToDevicePool releaseToGlobalPool | ||
LINK_EVENT | Permission receive link events | Link Service | addListener removeListener |
Link Resource Service | addListener removeListener | ||
Label Resource Service | addListener removeListener | ||
PACKET_READ | Permission to read packet information | Packet Context | time inPacket outPacket treatmentBuilder isHandled |
Packet Service | requestPackets | ||
ProxyArpService | isKnown | ||
PACKET_WRITE | Permission to send/block packet | Packet Context | send block |
Packet Service | emit | ||
ProxyArpService | reply forward handlePacket | ||
PACKET_EVENT | Permission to handle packet events | Packet Service | addProcessor removeProcessor |
STATISTIC_READ | Permission to access flow statistic information | Statistic Service | load max min higesthitter |
TOPOLOGY_READ | Permission to read path and topology information | Path Service | getPaths |
Topology Service | currentTopology isLatest getGraph getCluster(s) getClusterDevices getClusterLinks getPaths isInfrastructure isBroadcastPoint | ||
TOPOLOGY_EVENT | Permission to handle topology events | Topology Service | addListener removeListener |
TUNNEL_READ | Permission to read tunnel information | Tunnel Service | getTunnelCount getTunnel(s) |
TUNNEL_WRITE | Permission to create tunnels | Tunnel Service | requestTunnel |
TUNNEL_EVENT | Permission to receive tunnel events | Tunnel Service | addListener removeListener |
STORAGE_WRITE | Permission to create stores | Storage Service | eventuallyConsistentMapBuilder consistentMapBuilder setBuilder atomicCounterBuilder |