Changeset 215

Timestamp:

08/16/12 23:22:05 (12 years ago)

Author:

atzm

Message:

• add help messages

File:

• etherws/trunk/etherws.py (modified) (1 diff)

etherws/trunk/etherws.py

@@ -1010 +1010 @@
 
     # - sw
-    parser_sw = subcommand.add_parser('sw')
-
-    parser_sw.add_argument('--debug', action='store_true', default=False)
-    parser_sw.add_argument('--foreground', action='store_true', default=False)
-    parser_sw.add_argument('--ageout', type=int, default=300)
-
-    parser_sw.add_argument('--path', default='/')
-    parser_sw.add_argument('--host', default='')
-    parser_sw.add_argument('--port', type=int)
-    parser_sw.add_argument('--htpasswd')
-    parser_sw.add_argument('--sslkey')
-    parser_sw.add_argument('--sslcert')
-
-    parser_sw.add_argument('--ctlpath', default='/ctl')
-    parser_sw.add_argument('--ctlhost', default='127.0.0.1')
-    parser_sw.add_argument('--ctlport', type=int, default=7867)
-    parser_sw.add_argument('--ctlhtpasswd')
-    parser_sw.add_argument('--ctlsslkey')
-    parser_sw.add_argument('--ctlsslcert')
+    parser_sw = subcommand.add_parser('sw',
+                                      help='start virtual switch')
+
+    parser_sw.add_argument('--debug', action='store_true', default=False,
+                           help='run as debug mode')
+    parser_sw.add_argument('--foreground', action='store_true', default=False,
+                           help='run as foreground mode')
+    parser_sw.add_argument('--ageout', type=int, default=300,
+                           help='FDB ageout time (sec)')
+
+    parser_sw.add_argument('--path', default='/',
+                           help='http(s) path to serve WebSocket')
+    parser_sw.add_argument('--host', default='',
+                           help='listen address to serve WebSocket')
+    parser_sw.add_argument('--port', type=int,
+                           help='listen port to serve WebSocket')
+    parser_sw.add_argument('--htpasswd',
+                           help='path to htpasswd file to auth WebSocket')
+    parser_sw.add_argument('--sslkey',
+                           help='path to SSL private key for WebSocket')
+    parser_sw.add_argument('--sslcert',
+                           help='path to SSL certificate for WebSocket')
+
+    parser_sw.add_argument('--ctlpath', default='/ctl',
+                           help='http(s) path to serve control API')
+    parser_sw.add_argument('--ctlhost', default='127.0.0.1',
+                           help='listen address to serve control API')
+    parser_sw.add_argument('--ctlport', type=int, default=7867,
+                           help='listen port to serve control API')
+    parser_sw.add_argument('--ctlhtpasswd',
+                           help='path to htpasswd file to auth control API')
+    parser_sw.add_argument('--ctlsslkey',
+                           help='path to SSL private key for control API')
+    parser_sw.add_argument('--ctlsslcert',
+                           help='path to SSL certificate for control API')
 
     # - ctl
-    parser_ctl = subcommand.add_parser('ctl')
-    parser_ctl.add_argument('--ctlurl', default='http://127.0.0.1:7867/ctl')
-    parser_ctl.add_argument('--ctluser')
-    parser_ctl.add_argument('--ctlpasswd')
+    parser_ctl = subcommand.add_parser('ctl',
+                                       help='control virtual switch')
+    parser_ctl.add_argument('--ctlurl', default='http://127.0.0.1:7867/ctl',
+                            help='URL to control API')
+    parser_ctl.add_argument('--ctluser',
+                            help='username to auth control API')
+    parser_ctl.add_argument('--ctlpasswd',
+                            help='password to auth control API')
 
     control_method = parser_ctl.add_subparsers(dest='control_method')
 
     # -- ctl addport
-    parser_ctl_addport = control_method.add_parser('addport')
+    parser_ctl_addport = control_method.add_parser('addport',
+                                                   help='create and add port')
     iftype = parser_ctl_addport.add_subparsers(dest='iftype')
 
     # --- ctl addport tap
-    parser_ctl_addport_tap = iftype.add_parser(TapHandler.IFTYPE)
-    parser_ctl_addport_tap.add_argument('target')
+    parser_ctl_addport_tap = iftype.add_parser(TapHandler.IFTYPE,
+                                               help='TAP device')
+    parser_ctl_addport_tap.add_argument('target',
+                                        help='device name to create interface')
 
     # --- ctl addport client
-    parser_ctl_addport_client = iftype.add_parser(EtherWebSocketClient.IFTYPE)
-    parser_ctl_addport_client.add_argument('target')
-    parser_ctl_addport_client.add_argument('--user')
-    parser_ctl_addport_client.add_argument('--passwd')
-    parser_ctl_addport_client.add_argument('--cacerts')
+    parser_ctl_addport_client = iftype.add_parser(EtherWebSocketClient.IFTYPE,
+                                                  help='WebSocket client')
+    parser_ctl_addport_client.add_argument('target',
+                                           help='URL to connect WebSocket')
+    parser_ctl_addport_client.add_argument('--user',
+                                           help='username to auth WebSocket')
+    parser_ctl_addport_client.add_argument('--passwd',
+                                           help='password to auth WebSocket')
+    parser_ctl_addport_client.add_argument('--cacerts',
+                                           help='path to CA certificate')
     parser_ctl_addport_client.add_argument(
-        '--insecure', action='store_true', default=False)
+        '--insecure', action='store_true', default=False,
+        help='do not verify server certificate')
 
     # -- ctl setport
-    parser_ctl_setport = control_method.add_parser('setport')
-    parser_ctl_setport.add_argument('port', type=int)
-    parser_ctl_setport.add_argument('--shut', type=int, choices=(0, 1))
+    parser_ctl_setport = control_method.add_parser('setport',
+                                                   help='set port config')
+    parser_ctl_setport.add_argument('port', type=int,
+                                    help='port number to set config')
+    parser_ctl_setport.add_argument('--shut', type=int, choices=(0, 1),
+                                    help='set shutdown state')
 
     # -- ctl delport
-    parser_ctl_delport = control_method.add_parser('delport')
-    parser_ctl_delport.add_argument('port', type=int)
+    parser_ctl_delport = control_method.add_parser('delport',
+                                                   help='delete port')
+    parser_ctl_delport.add_argument('port', type=int,
+                                    help='port number to delete')
 
     # -- ctl listport
-    parser_ctl_listport = control_method.add_parser('listport')
+    parser_ctl_listport = control_method.add_parser('listport',
+                                                    help='show port list')
 
     # -- ctl setif
-    parser_ctl_setif = control_method.add_parser('setif')
-    parser_ctl_setif.add_argument('port', type=int)
-    parser_ctl_setif.add_argument('--address')
-    parser_ctl_setif.add_argument('--netmask')
-    parser_ctl_setif.add_argument('--mtu', type=int)
+    parser_ctl_setif = control_method.add_parser('setif',
+                                                 help='set interface config')
+    parser_ctl_setif.add_argument('port', type=int,
+                                  help='port number to set config')
+    parser_ctl_setif.add_argument('--address',
+                                  help='IPv4 address to set interface')
+    parser_ctl_setif.add_argument('--netmask',
+                                  help='IPv4 netmask to set interface')
+    parser_ctl_setif.add_argument('--mtu', type=int,
+                                  help='MTU to set interface')
 
     # -- ctl listif
-    parser_ctl_listif = control_method.add_parser('listif')
+    parser_ctl_listif = control_method.add_parser('listif',
+                                                  help='show interface list')
 
     # -- ctl listfdb
-    parser_ctl_listfdb = control_method.add_parser('listfdb')
+    parser_ctl_listfdb = control_method.add_parser('listfdb',
+                                                   help='show FDB entries')
 
     # -- go