inlinetoc

ryu.app.ofctl_rest fournit des API REST permettant de récupérer les statistiques du commutateur et de mettre à jour les statistiques du commutateur. Cette application vous aide à déboguer votre application et à obtenir diverses statistiques.

Cette application prend en charge OpenFlow version 1.0, 1.2, 1.3, 1.4 et 1.5.

Obtenir la liste de tous les commutateurs connectés au contrôleur.

$ curl -X GET http://localhost:8080/stats/switches

 [
  1 ,
  2 ,
  3
]

Obtenir les statistiques de descente du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/desc/1

 {
  "1" : {
  "mfr_desc" : "Nicira, Inc." ,
  "hw_desc" : "Open vSwitch" ,
  "sw_desc" : "2.3.90" ,
  "serial_num" : "None" ,
  "dp_desc" : "None"
  }
}

Obtenir toutes les statistiques de flux du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/flow/1

Réponse (OpenFlow1.3 ou version antérieure):

 {
  "1" : [
  {
  "length" : 88 ,
  "table_id" : 0 ,
  "duration_sec" : 2 ,
  "duration_nsec" : 6.76e+08 ,
  "priority" : 11111 ,
  "idle_timeout" : 0 ,
  "hard_timeout" : 0 ,
  "flags" : 1 ,
  "cookie" : 1 ,
  "packet_count" : 0 ,
  "byte_count" : 0 ,
  "match" : {
    "in_port" : 1
  },
  "actions" : [
    "OUTPUT:2"
  ]
  }
  ]
}

Obtenez les statistiques de flux du commutateur filtrées par les champs OFPFlowStats. Ceci est la version POST de la méthode Obtenir toutes les statistiques de flux .

Identique à Obtenir toutes les statistiques de flux

$ curl -X POST -d '{
   "table_id": 0,
   "out_port": 2,
   "cookie": 1,
   "cookie_mask": 1,
   "match":{
   "in_port":1
   }
 }' http://localhost:8080/stats/flow/1

Réponse (OpenFlow1.3 ou version antérieure):

 {
  "1" : [
  {
  "length" : 88 ,
  "table_id" : 0 ,
  "duration_sec" : 2 ,
  "duration_nsec" : 6.76e+08 ,
  "priority" : 11111 ,
  "idle_timeout" : 0 ,
  "hard_timeout" : 0 ,
  "flags" : 1 ,
  "cookie" : 1 ,
  "packet_count" : 0 ,
  "byte_count" : 0 ,
  "match" : {
    "in_port" : 1
  },
  "actions" : [
    "OUTPUT:2"
  ]
  }
  ]
}

Obtenir des statistiques de flux globales du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/aggregateflow/1

 {
  "1" : [
  {
  "packet_count" : 18 ,
  "byte_count" : 756 ,
  "flow_count" : 3
  }
  ]
}

Obtenir des statistiques de flux globales du commutateur filtrées par les champs OFPAggregateStats. Ceci est la version POST de la méthode Obtenir des statistiques de flux globales .

Identique à celui des statistiques de flux globales

$ curl -X POST -d '{
   "table_id": 0,
   "out_port": 2,
   "cookie": 1,
   "cookie_mask": 1,
   "match":{
   "in_port":1
   }
 }' http://localhost:8080/stats/aggregateflow/1

 {
  "1" : [
  {
  "packet_count" : 18 ,
  "byte_count" : 756 ,
  "flow_count" : 3
  }
  ]
}

Obtenir les statistiques de table du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/table/1

 {
  "1" : [
  {
  "active_count" : 0 ,
  "table_id" : 0 ,
  "lookup_count" : 8 ,
  "matched_count" : 0
  },
  ...
  {
  "active_count" : 0 ,
  "table_id" : 253 ,
  "lookup_count" : 0 ,
  "matched_count" : 0
  }
  ]
}

Obtenir les caractéristiques de table du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/tablefeatures/1

 {
  "1" : [
  {
  "metadata_write" : 18446744073709552000 ,
  "config" : 0 ,
  "table_id" : 0 ,
  "metadata_match" : 18446744073709552000 ,
  "max_entries" : 4096 ,
  "properties" : [
    {
    "type" : "INSTRUCTIONS" ,
    "instruction_ids" : [
     {
     "len" : 4 ,
     "type" : 1
     },
     ...
    ]
    },
    ...
  ],
  "name" : "table_0"
  },
  {
  "metadata_write" : 18446744073709552000 ,
  "config" : 0 ,
  "table_id" : 1 ,
  "metadata_match" : 18446744073709552000 ,
  "max_entries" : 4096 ,
  "properties" : [
    {
    "type" : "INSTRUCTIONS" ,
    "instruction_ids" : [
     {
     "len" : 4 ,
     "type" : 1
     },
     ...
    ]
    },
    ...
  ],
  "name" : "table_1"
  },
  ...
  ]
}

Obtenir les statistiques de ports du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/port/1

Réponse (OpenFlow1.3 ou version antérieure):

 {
  "1" : [
  {
  "port_no" : 1 ,
  "rx_packets" : 9 ,
  "tx_packets" : 6 ,
  "rx_bytes" : 738 ,
  "tx_bytes" : 252 ,
  "rx_dropped" : 0 ,
  "tx_dropped" : 0 ,
  "rx_errors" : 0 ,
  "tx_errors" : 0 ,
  "rx_frame_err" : 0 ,
  "rx_over_err" : 0 ,
  "rx_crc_err" : 0 ,
  "collisions" : 0 ,
  "duration_sec" : 12 ,
  "duration_nsec" : 9.76e+08
  },
  {
  :
  :
  }
  ]
}

Obtenir la description des ports du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/portdesc/1

Réponse (OpenFlow1.3 ou version antérieure):

 {
  "1" : [
  {
  "port_no" : 1 ,
  "hw_addr" : "0a:b6:d0:0c:e1:d7" ,
  "name" : "s1-eth1" ,
  "config" : 0 ,
  "state" : 0 ,
  "curr" : 2112 ,
  "advertised" : 0 ,
  "supported" : 0 ,
  "peer" : 0 ,
  "curr_speed" : 1 e + 07 ,
  "max_speed" : 0
  },
  {
  :
  :
  }
  ]
}

Obtenir les statistiques de la file d'attente du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/queue/1

Réponse (OpenFlow1.3 ou version antérieure):

 {
  "1" : [
  {
  "port_no" : 1 ,
  "queue_id" : 0 ,
  "tx_bytes" : 0 ,
  "tx_packets" : 0 ,
  "tx_errors" : 0 ,
  "duration_sec" : 4294963425 ,
  "duration_nsec" : 3912967296
  },
  {
  "port_no" : 1 ,
  "queue_id" : 1 ,
  "tx_bytes" : 0 ,
  "tx_packets" : 0 ,
  "tx_errors" : 0 ,
  "duration_sec" : 4294963425 ,
  "duration_nsec" : 3912967296
  }
  ]
}

Obtenir la configuration des files d'attente du commutateur spécifié avec l'ID Datapath et le port dans l'URI.

$ curl -X GET http://localhost:8080/stats/queueconfig/1/1

 {
  "1" : [
  {
  "port" : 1 ,
  "queues" : [
    {
    "properties" : [
    {
      "property" : "MIN_RATE" ,
      "rate" : 80
    }
    ],
    "port" : 0 ,
    "queue_id" : 1
    },
    {
    "properties" : [
    {
      "property" : "MAX_RATE" ,
      "rate" : 120
    }
    ],
    "port" : 2 ,
    "queue_id" : 2
    },
    {
    "properties" : [
    {
      "property" : "EXPERIMENTER" ,
      "data" : [],
      "experimenter" : 999
    }
    ],
    "port" : 3 ,
    "queue_id" : 3
    }
  ]
  }
  ]
}

Obtenir la description des files d'attente du commutateur spécifié avec l'ID, le port et le Queue_id de Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/queuedesc/1/1/1

 {
 "1" : [
   {
   "len" : 88 ,
   "port_no" : 1 ,
   "queue_id" : 1 ,
   "properties" : [
   {
     "length" : 8 ,
     "rate" : 300 ,
     "type" : "MIN_RATE"
   },
   {
     "length" : 8 ,
     "rate" : 900 ,
     "type" : "MAX_RATE"
   },
   {
     "length" : 16 ,
     "exp_type" : 0 ,
     "experimenter" : 101 ,
     "data" : [ 1 ],
     "type" : "EXPERIMENTER"
   },
   {
     :

     :
   }
   ]
   }
 ]
 }

Obtenir les statistiques de groupes du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/group/1

 {
  "1" : [
  {
  "length" : 56 ,
  "group_id" : 1 ,
  "ref_count" : 1 ,
  "packet_count" : 0 ,
  "byte_count" : 0 ,
  "duration_sec" : 161 ,
  "duration_nsec" : 3.03e+08 ,
  "bucket_stats" : [
    {
    "packet_count" : 0 ,
    "byte_count" : 0
    }
  ]
  }
  ]
}

Obtenir les statistiques de description de groupe du commutateur spécifié avec l'ID Datapath dans l'URI.

Utilisation (Openflow1.4 ou antérieure):

$ curl -X GET http://localhost:8080/stats/groupdesc/1

Réponse (Openflow1.3 ou antérieure):

 {
  "1" : [
  {
  "type" : "ALL" ,
  "group_id" : 1 ,
  "buckets" : [
    {
    "weight" : 0 ,
    "watch_port" : 4294967295 ,
    "watch_group" : 4294967295 ,
    "actions" : [
    "OUTPUT:1"
    ]
    }
  ]
  }
  ]
}

Obtenir les statistiques des fonctionnalités de groupe du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/groupfeatures/1

 {
  "1" : [
  {
  "types" : [],
  "capabilities" : [
    "SELECT_WEIGHT" ,
    "SELECT_LIVENESS" ,
    "CHAINING"
  ],
  "max_groups" : [
    {
    "ALL" : 4294967040
    },
    {
    "SELECT" : 4294967040
    },
    {
    "INDIRECT" : 4294967040
    },
    {
    "FF" : 4294967040
    }
  ],
  "actions" : [
    {
    "ALL" : [
    "OUTPUT" ,
    "COPY_TTL_OUT" ,
    "COPY_TTL_IN" ,
    "SET_MPLS_TTL" ,
    "DEC_MPLS_TTL" ,
    "PUSH_VLAN" ,
    "POP_VLAN" ,
    "PUSH_MPLS" ,
    "POP_MPLS" ,
    "SET_QUEUE" ,
    "GROUP" ,
    "SET_NW_TTL" ,
    "DEC_NW_TTL" ,
    "SET_FIELD"
    ]
    },
    {
    "SELECT" : []
    },
    {
    "INDIRECT" : []
    },
    {
    "FF" : []
    }
  ]
  }
  ]
}

Obtenir les statistiques des compteurs du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/meter/1

 {
  "1" : [
  {
  "meter_id" : 1 ,
  "len" : 56 ,
  "flow_count" : 0 ,
  "packet_in_count" : 0 ,
  "byte_in_count" : 0 ,
  "duration_sec" : 37 ,
  "duration_nsec" : 988000 ,
  "band_stats" : [
    {
    "packet_band_count" : 0 ,
    "byte_band_count" : 0
    }
  ]
  }
  ]
}

Obtenir les statistiques de configuration de compteur du commutateur spécifié avec l'ID Datapath dans l'URI.

Mise en garde: Ce message a été renommé dans openflow 1.5. Si Openflow 1.4 ou une version antérieure est en cours d'utilisation, veuillez utiliser la commande Obtenir la description du compteur. Si Openflow 1.5 ou version ultérieure est en cours d'utilisation, veuillez utiliser la commande Obtenir une description de compteur.

$ curl -X GET http://localhost:8080/stats/meterconfig/1

 {
  "1" : [
  {
  "flags" : [
    "KBPS"
  ],
  "meter_id" : 1 ,
  "bands" : [
    {
    "type" : "DROP" ,
    "rate" : 1000 ,
    "burst_size" : 0
    }
  ]
  }
  ]
}

Obtenir les caractéristiques des compteurs statistiques du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X GET http://localhost:8080/stats/meterfeatures/1

 {
  "1" : [
  {
  "max_meter" : 256 ,
  "band_types" : [
    "DROP"
  ],
  "capabilities" : [
    "KBPS" ,
    "BURST" ,
    "STATS"
  ],
  "max_bands" : 16 ,
  "max_color" : 8
  }
  ]
}

Obtenir le rôle actuel du contrôleur auprès du commutateur.

$ curl -X GET http://localhost:8080/stats/role/1

Réponse (Openflow1.4 ou antérieure):

 {
  "1" : [
    {
    "generation_id" : 0 ,
    "role" : "EQUAL"
    }
  ]
}

Ajouter une entrée de flux au commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "cookie": 1,
  "cookie_mask": 1,
  "table_id": 0,
  "idle_timeout": 30,
  "hard_timeout": 30,
  "priority": 11111,
  "flags": 1,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/add

$ curl -X POST -d '{
  "dpid": 1,
  "priority": 22222,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"GOTO_TABLE",
    "table_id": 1
    }
  ]
 }' http://localhost:8080/stats/flowentry/add

$ curl -X POST -d '{
  "dpid": 1,
  "priority": 33333,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"WRITE_METADATA",
    "metadata": 1,
    "metadata_mask": 1
    }
  ]
 }' http://localhost:8080/stats/flowentry/add

$ curl -X POST -d '{
  "dpid": 1,
  "priority": 44444,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"METER",
    "meter_id": 1
    }
  ]
 }' http://localhost:8080/stats/flowentry/add

Modifier toutes les entrées de flux correspondantes du commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "cookie": 1,
  "cookie_mask": 1,
  "table_id": 0,
  "idle_timeout": 30,
  "hard_timeout": 30,
  "priority": 11111,
  "flags": 1,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/modify

Modifier une entrée de flux correspondant strictement aux caractères génériques et à la priorité

$ curl -X POST -d '{
  "dpid": 1,
  "cookie": 1,
  "cookie_mask": 1,
  "table_id": 0,
  "idle_timeout": 30,
  "hard_timeout": 30,
  "priority": 11111,
  "flags": 1,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/modify\_strict

Supprimer toutes les entrées de flux correspondantes du commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "cookie": 1,
  "cookie_mask": 1,
  "table_id": 0,
  "idle_timeout": 30,
  "hard_timeout": 30,
  "priority": 11111,
  "flags": 1,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/delete

Supprimer une entrée de flux correspondant strictement aux caractères génériques et à la priorité.

$ curl -X POST -d '{
  "dpid": 1,
  "cookie": 1,
  "cookie_mask": 1,
  "table_id": 0,
  "idle_timeout": 30,
  "hard_timeout": 30,
  "priority": 11111,
  "flags": 1,
  "match":{
    "in_port":1
  },
  "actions":[
    {
    "type":"OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/delete\_strict

Supprimer toutes les entrées de flux du commutateur spécifié avec l'ID Datapath dans l'URI.

$ curl -X DELETE http://localhost:8080/stats/flowentry/clear/1

Ajouter une entrée de groupe au commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "type": "ALL",
  "group_id": 1,
  "buckets": [
    {
    "actions": [
      {
        "type": "OUTPUT",
        "port": 1
      }
    ]
    }
  ]
 }' http://localhost:8080/stats/groupentry/add

Modifier une entrée de groupe sur le commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "type": "ALL",
  "group_id": 1,
  "buckets": [
    {
    "actions": [
      {
        "type": "OUTPUT",
        "port": 1
      }
    ]
    }
  ]
 }' http://localhost:8080/stats/groupentry/modify

Supprimer une entrée de groupe sur le commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "group_id": 1
 }' http://localhost:8080/stats/groupentry/delete

Modifier le comportement du port physique.

Demander le corps du message:

$ curl -X POST -d '{
  "dpid": 1,
  "port_no": 1,
  "config": 1,
  "mask": 1
  }' http://localhost:8080/stats/portdesc/modify

Ajouter une entrée de compteur au commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "flags": "KBPS",
  "meter_id": 1,
  "bands": [
    {
    "type": "DROP",
    "rate": 1000
    }
  ]
 }' http://localhost:8080/stats/meterentry/add

Modifier une entrée de compteur au commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "meter_id": 1,
  "flags": "KBPS",
  "bands": [
    {
    "type": "DROP",
    "rate": 1000
    }
  ]
 }' http://localhost:8080/stats/meterentry/modify

Supprimer une entrée de compteur au commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "meter_id": 1
 }' http://localhost:8080/stats/meterentry/delete

modifier le rôle du commutateur.

$ curl -X POST -d '{
  "dpid": 1,
  "role": "MASTER"
 }' http://localhost:8080/stats/role

Liste des champs de correspondance (OpenFlow1.2 ou version ultérieure):

Certains champs peuvent être décrits avec un masque comme suit.

• Adresse Ethernet:

"aa:bb:cc:11:22:33"
"aa:bb:cc:11:22:33/00:00:00:00:ff:ff"

• Adresse IPv4:

"192.168.0.11"
"192.168.0.44/24"
"192.168.10.10/255.255.255.0"

• Adresse IPv6:

"2001::ffff:cccc:bbbb:1111"
"2001::ffff:cccc:bbbb:2222/64"
"2001::ffff:cccc:bbbb:2222/ffff:ffff:ffff:ffff::0"

• Métadonnées:

"0x1212121212121212"
"0x3434343434343434/0x01010101010101010"

• Pour faire correspondre uniquement les paquets dont l'étiquette VLAN et l'ID de VLAN sont égaux à la valeur 5:

  $ curl -X POST -d '{
    "dpid": 1,
    "match":{
    "dl\_vlan": 5
    },
    "actions":[
    {
      "type":"OUTPUT",
      "port": 1
    }
    ]
   }' http://localhost:8080/stats/flowentry/add

• Pour faire correspondre uniquement les paquets sans balise VLAN:

  $ curl -X POST -d '{
    "dpid": 1,
    "match":{
    "dl_vlan": "0x0000" # Describe OFPVID_NONE(0x0000)
    },
    "actions":[
    {
      "type":"OUTPUT",
      "port": 1
    }
    ]
   }' http://localhost:8080/stats/flowentry/add

• Pour faire correspondre uniquement les paquets avec une balise VLAN, quelle que soit sa valeur:

  $ curl -X POST -d '{
    "dpid": 1,
    "match":{
    "dl_vlan": "0x1000/0x1000" # Describe OFPVID_PRESENT(0x1000/0x1000)
    },
    "actions":[
    {
      "type":"OUTPUT",
      "port": 1
    }
    ]
   }' http://localhost:8080/stats/flowentry/add

• Pour faire correspondre uniquement les paquets dont l'étiquette VLAN et l'ID de VLAN sont égaux à la valeur 5:

  $ curl -X POST -d '{
    "dpid": 1,
    "match":{
    "dl_vlan": "0x1005" # Describe sum of VLAN-ID(e.g. 5) | OFPVID_PRESENT(0x1000)
    },
    "actions":[
    {
      "type":"OUTPUT",
      "port": 1
    }
    ]
   }' http://localhost:8080/stats/flowentry/add

Liste des actions (OpenFlow1.2 ou ultérieur):

Pour définir l'ID de VLAN sur une trame étiquetée non-VLAN:

$ curl -X POST -d '{
  "dpid": 1,
  "match":{
    "dl_type": "0x8000"
  },
  "actions":[
    {
    "type": "PUSH_VLAN",   # Push a new VLAN tag if a input frame is non-VLAN-tagged
    "ethertype": 33024   # Ethertype 0x8100(=33024): IEEE 802.1Q VLAN-tagged frame
    },
    {
    "type": "SET_FIELD",
    "field": "vlan_vid",   # Set VLAN ID
    "value": 4102    # Describe sum of vlan_id(e.g. 6) | OFPVID_PRESENT(0x1000=4096)
    },
    {
    "type": "OUTPUT",
    "port": 2
    }
  ]
 }' http://localhost:8080/stats/flowentry/add