@@ -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