Have questions? Stuck? Please check our FAQ for some common questions and answers.

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)

getIdGenerator

APP_WRITEPermission to register new applicationCore Service

registerApplication

APP_EVENT

Permission to receive application lifecycle events

Application Service

addListener

removeListener

CONFIG_READ

 

Permission to read configuration properties

 

Component Config Service

getComponentNames

getProperties

Network Config Service

getSubjectClasees

getSubjectFactory

getConfigClass

getSubjects

getConfig

CONFIG_WRITE

 

Permission to write configuration properties

 

Component Config Service

registerProperties

unregisterProperties

setProperty

unsetProperty

preSetProperty

 Network Config Service

addConfig

applyConfig

removeConfig

CODEC_READPermission to read codec informationCodec Service

getCodec(s)

CODEC_WRITEPermission to add/remove entityclass from codecsCodec Service

registerCodec

unregisterCodec

CLOCK_WRITEPermission to write clock propertiesLogical Clock ServicegetTimestamp

CLUSTER_READ

Permission to read cluster information

Cluster Service

getLocalNode

getNode(s)

getState

getLastUpdated

Cluster Metadata Service

getClusterMetadata

getLocalNode

MastershipTermServicegetMastershipTerm

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

getPortdeltaStatistics

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

DEVICE_KEY_READPermission to read device keyDevice Key Service getDeviceKey(s)
EVENT_READPermission to read event propertiesEvent Delivery ServicegetDispatchTimeLimit
EVENT_WRITEPermission to write event propertiesEvent Delivery ServicesetDispatchTimeLimit

FLOWRULE_READ

Permission to read flow rule information

Flow Rule Service

getFlowRuleCount

getFlowEntries

getFlowRulesById

getFlowRulesByGroupId

getFlowTableStatistics

FLOWRULE_WRITE

Permission to add/remove flow rules

Flow Rule Service

applyFlowRules

removeFlowRules

removeFlowRulesById

apply

FlowObjectiveService

filter

forward

next

allocateNextId

initPolicy

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

getIntentData

Intent Extention ServicegetCompilers
Intent Partition Service

isMine

getLeader

Partition Service

isMine

getLeader

Intent Clock Service

getTimestamp

INTENT_WRITE

 

Permission to add/remove intents

 

Intent Service

submit

withdraw

purge

 Intent Extention Service

registerCompiler

unregisterCompiler

INTENT_EVENT

 

Permission receive intent events

 

Intent Service

addListener

removeListener

Intent Partition Service

adListener

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

MUTEX_WRITEPermission to execute mutex taskMutex Excusion Serviceexecute

PACKET_READ

Permission to read packet information

Packet Context

time

inPacket

outPacket

treatmentBuilder

isHandled

Packet Service

requestPackets

getProcessors

cancelPackets

getRequests

ProxyArpService

isKnown

PACKET_WRITE

Permission to send/block packet

Packet Context

send

block

Packet Service

emit

ProxyArpService

reply

forward

handlePacket

Edge Port ServiceemitPacket

PACKET_EVENT

Permission to handle packet events

Packet Service

addProcessor

removeProcessor

PARTITION_READPermission to read partition informationPartition Service

getNumberOfPartitions

getConfiguredMembers

getActiveMembersNumbers

getAllPartitionIds

getDistributedPrimitiveCreator

PARTITION_EVENTPermission to handle partition eventsPartition Service

addListener

removeListener

PERSISTENCE_WRITEPermission to create persistent builderPersistence Service

persistentSetBuilder

persistentMapBuilder

REGION_READPermission to read region informationRegion Service

getRegion(s)

getRegionForDevice(s)

RESOURCE_READPermission to read resource informationResource Service

getResourceAllocations

getAvailableResources

getAvailableResourceValues

getRegisterdResources

isAvailalble

RESOURCE_WRITEPermission to allocate/release resourceResource Service

allocate

release

RESOURCE_EVENTPermission to handle resource eventsResource Service

addListener

removeListener

STATISTIC_READ

 

Permission to access flow statistic information

 

 

 

Statistic Service

 

 

load

max

min

highesthitter

Flow Statistics Service

loadSummary

loadAllByType

loadTopnByType

TOPOLOGY_READ

Permission to read path and topology information

Path Service

getPaths

getDisjointPaths

Topology Service

currentTopology

isLatest

getGraph

getCluster(s)

getClusterDevices

getClusterLinks

getPaths

isInfrastructure

isBroadcastPoint

getDisjointPaths

Edge Port Service

isEdgePoint

getEdgePoints

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

 UI_READPermission to read UI informationUi Extension Service

getExtentions

getViewExtention

 UI_WRITEPermission to create/remove UI serviceUi Extension Service

register

unregister

STORAGE_WRITE

Permission to create stores

Storage Service

eventuallyConsistentMapBuilder

consistentMapBuilder

setBuilder

atomicCounterBuilder

queueBuilder

atomicValueBuilder

leaderElectorBuilder

 

 

 

  • No labels