Skip to content

Commit 9599f58

Browse files
docs: 🐛 Fix docstring typos
1 parent 9145055 commit 9599f58

2 files changed

Lines changed: 25 additions & 4 deletions

File tree

pyedgeconnect/orch/_deployment.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def get_appliance_deployment(
141141
* keyword **maxInBWEnabled** (`bool`): Enable inbound
142142
bandwidth shaping (if this is true, you must specify
143143
maxInBW)
144-
* keyword **licence** (`dict`): Appliance EC license
144+
* keyword **license** (`dict`): Appliance EC license
145145
information (only valid for EC models) \n
146146
* keyword **ecMini** (`bool`): Is EC Mini license
147147
enabled

pyedgeconnect/orch/_inbound_shaper.py

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,30 @@ def get_appliance_inbound_shaper(
2626
:param cached: ``True`` retrieves last known value to Orchestrator,
2727
``False`` retrieves values directly from Appliance
2828
:type cached: bool
29-
:return: Returns dictionary where each key is a segment id that
30-
contains its associated DNS proxy configuration (profiles,
31-
domain groups and maps).
29+
:return: Returns dictionary of inbound shaper configuration on
30+
appliance \n
31+
* keyword **<interface_name>** (`dict`): Interface shaper
32+
configuration. ``wan`` specifies system WAN shaper. \n
33+
* keyword **accuracy** (`int`): related to underlying shaper
34+
credit, not a user-configured parameter
35+
* keyword **dyn_bw_enable** (`bool`): If dynamic bandwidth
36+
is configured on interface inbound shaper
37+
* keyword **enable** (`bool`): If inbound shaper enabled on
38+
interface
39+
* keyword **max_bw** (`int`): Maximum bandwidth for interface
40+
in kbps
41+
* keyword **traffic-class** (`dict`): Traffic class configs \n
42+
* keyword **<traffic_class_int>** (`dict`): Config of
43+
traffic class \n
44+
* keyword **excess** (`int`): Excess weighting
45+
* keyword **flow_limit** (`int`): Flow limit
46+
* keyword **max_bw** (`int`): Percentage max bandwidth
47+
* keyword **max_bw_abs** (`int`): Absolute max bandwidth
48+
* keyword **max_wait** (`int`): Max wait time
49+
* keyword **min_bw** (`int`): Percentage min bandwidth
50+
* keyword **min_bw_abs** (`int`): Absolute min bandwidth
51+
* keyword **name** (`str`): Name of traffic class
52+
* keyword **priority** (`int`): Priority in traffic map
3253
:rtype: dict
3354
"""
3455
return self._get("/inboundShaper/{}?cached={}".format(ne_id, cached))

0 commit comments

Comments
 (0)