mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Renaming things & more inline docs.
This commit is contained in:
1 parent
d68a24e39d
commit
687d5b75ab
35 files changed
+82
-96
No files matched your search
@@ -28,7 +28,7 @@ class ATMBridge(object):
|
||||
"""
|
||||
Dynamips bridge switch.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this switch
|
||||
"""
|
||||
|
||||
@@ -69,7 +69,7 @@ class ATMBridge(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -115,7 +115,7 @@ class ATMBridge(object):
|
||||
"""
|
||||
Adds a NIO as new port on ATM bridge.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
:param port: port to allocate for the NIO
|
||||
"""
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ class ATMSwitch(object):
|
||||
"""
|
||||
Dynamips ATM switch.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this switch
|
||||
"""
|
||||
|
||||
@@ -121,7 +121,7 @@ class ATMSwitch(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -182,7 +182,7 @@ class ATMSwitch(object):
|
||||
"""
|
||||
Adds a NIO as new port on ATM switch.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
:param port: port to allocate for the NIO
|
||||
"""
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ class Bridge(object):
|
||||
"""
|
||||
Dynamips bridge.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this bridge
|
||||
"""
|
||||
|
||||
@@ -73,7 +73,7 @@ class Bridge(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -110,7 +110,7 @@ class Bridge(object):
|
||||
"""
|
||||
Adds a NIO as new port on this bridge.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
"""
|
||||
|
||||
self._hypervisor.send("nio_bridge add_nio {name} {nio}".format(name=self._name,
|
||||
@@ -121,7 +121,7 @@ class Bridge(object):
|
||||
"""
|
||||
Removes the specified NIO as member of this bridge.
|
||||
|
||||
:param nio: NIO object to remove
|
||||
:param nio: NIO instance to remove
|
||||
"""
|
||||
|
||||
self._hypervisor.send("nio_bridge remove_nio {name} {nio}".format(name=self._name,
|
||||
|
||||
@@ -33,7 +33,7 @@ class C1700(Router):
|
||||
"""
|
||||
Dynamips c1700 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
:param chassis: chassis for this router:
|
||||
1720, 1721, 1750, 1751 or 1760 (default = 1720).
|
||||
|
||||
@@ -35,7 +35,7 @@ class C2600(Router):
|
||||
"""
|
||||
Dynamips c2600 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
:param chassis: chassis for this router:
|
||||
2610, 2611, 2620, 2621, 2610XM, 2611XM
|
||||
|
||||
@@ -32,7 +32,7 @@ class C2691(Router):
|
||||
"""
|
||||
Dynamips c2691 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
"""
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ class C3600(Router):
|
||||
"""
|
||||
Dynamips c3600 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
:param chassis: chassis for this router:
|
||||
3620, 3640 or 3660 (default = 3640).
|
||||
|
||||
@@ -32,7 +32,7 @@ class C3725(Router):
|
||||
"""
|
||||
Dynamips c3725 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
"""
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ class C3745(Router):
|
||||
"""
|
||||
Dynamips c3745 router.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
"""
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ class C7200(Router):
|
||||
"""
|
||||
Dynamips c7200 router (model is 7206).
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
:param npe: default NPE
|
||||
"""
|
||||
|
||||
@@ -32,7 +32,7 @@ class EthernetSwitch(object):
|
||||
"""
|
||||
Dynamips Ethernet switch.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this switch
|
||||
"""
|
||||
|
||||
@@ -122,7 +122,7 @@ class EthernetSwitch(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -172,7 +172,7 @@ class EthernetSwitch(object):
|
||||
"""
|
||||
Adds a NIO as new port on Ethernet switch.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
:param port: port to allocate for the NIO
|
||||
"""
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ class FrameRelaySwitch(object):
|
||||
"""
|
||||
Dynamips Frame Relay switch.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this switch
|
||||
"""
|
||||
|
||||
@@ -121,7 +121,7 @@ class FrameRelaySwitch(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -182,7 +182,7 @@ class FrameRelaySwitch(object):
|
||||
"""
|
||||
Adds a NIO as new port on Frame Relay switch.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
:param port: port to allocate for the NIO
|
||||
"""
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ class Hub(Bridge):
|
||||
"""
|
||||
Dynamips hub (based on Bridge)
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this hub
|
||||
"""
|
||||
|
||||
@@ -102,7 +102,7 @@ class Hub(Bridge):
|
||||
"""
|
||||
Adds a NIO as new port on this hub.
|
||||
|
||||
:param nio: NIO object to add
|
||||
:param nio: NIO instance to add
|
||||
:param port: port to allocate for the NIO
|
||||
"""
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ class Router(object):
|
||||
"""
|
||||
Dynamips router implementation.
|
||||
|
||||
:param hypervisor: Dynamips hypervisor object
|
||||
:param hypervisor: Dynamips hypervisor instance
|
||||
:param name: name for this router
|
||||
:param platform: c7200, c3745, c3725, c3600, c2691, c2600 or c1700
|
||||
:param ghost_flag: used when creating a ghost IOS.
|
||||
@@ -221,7 +221,7 @@ class Router(object):
|
||||
"""
|
||||
Returns the current hypervisor.
|
||||
|
||||
:returns: hypervisor object
|
||||
:returns: hypervisor instance
|
||||
"""
|
||||
|
||||
return self._hypervisor
|
||||
@@ -1102,7 +1102,7 @@ class Router(object):
|
||||
Adds a slot binding (a module into a slot).
|
||||
|
||||
:param slot_id: slot ID
|
||||
:param adapter: device to add in the corresponding slot (object)
|
||||
:param adapter: device to add in the corresponding slot
|
||||
"""
|
||||
|
||||
try:
|
||||
@@ -1186,7 +1186,7 @@ class Router(object):
|
||||
Installs a WIC adapter into this router.
|
||||
|
||||
:param wic_slot_id: WIC slot ID
|
||||
:param wic: WIC to be install (object)
|
||||
:param wic: WIC to be installed
|
||||
"""
|
||||
|
||||
# WICs are always installed on adapters in slot 0
|
||||
@@ -1271,7 +1271,7 @@ class Router(object):
|
||||
|
||||
:param slot_id: slot ID
|
||||
:param port_id: port ID
|
||||
:param nio: NIO to add to the slot/port (object)
|
||||
:param nio: NIO instance to add to the slot/port
|
||||
"""
|
||||
|
||||
try:
|
||||
@@ -1304,7 +1304,7 @@ class Router(object):
|
||||
:param slot_id: slot ID
|
||||
:param port_id: port ID
|
||||
|
||||
:returns: removed NIO object
|
||||
:returns: removed NIO instance
|
||||
"""
|
||||
|
||||
try:
|
||||
|
||||
Reference in new issue
Block a user