diff --git a/py-json/LANforge/lf_json_autogen.py b/py-json/LANforge/lf_json_autogen.py index 524f5965..f3d1b008 100644 --- a/py-json/LANforge/lf_json_autogen.py +++ b/py-json/LANforge/lf_json_autogen.py @@ -1,6 +1,8 @@ #!/usr/bin/env python3 """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated by LANforge JsonApiPythonGenerator, Wed Jun 30 13:53:58 PDT 2021 + Generated by LANforge JsonApiPythonGenerator, Wed Aug 04 22:56:41 PDT 2021 + - - WORK IN PROGRESS - - + The API this library provides is actively being changed. This file expects to live in py-json/LANforge directory. ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" import keyword @@ -17,7 +19,7 @@ class LFJsonGet(LFCliBase): _exit_on_error=False, _exit_on_fail=False, _proxy_str=None, - _capture_signal_list=[] + _capture_signal_list=None ): super().__init__(_lfjson_host=lfclient_host, _lfjson_port=lfclient_port, @@ -64,6 +66,11 @@ class LFJsonGet(LFCliBase): module+8, name, script, state, temperature Example URL: /attenuator?fields=entity+id,module+1 + Example py-json call: + record = LFJsonGet.get_attenuator( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'entity id': X @@ -83,21 +90,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_attenuator(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/attenuator" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -113,8 +128,8 @@ class LFJsonGet(LFCliBase): ...examples how to call method(s) here... Request one of these URLs: - /chamber - /chamber$chamber_name + /chamber/ + /chamber/$chamber_name When requesting specific column names, they need to be URL Encoded. chamber, chamber+connections, chamber+resources, chamber+type, duts, entity+id, @@ -123,6 +138,11 @@ class LFJsonGet(LFCliBase): turntable+type, virtual Example URL: /chamber?fields=chamber,chamber+connections + Example py-json call: + record = LFJsonGet.get_chamber( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'chamber': X @@ -151,21 +171,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_chamber(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/chamber" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -176,6 +204,61 @@ class LFJsonGet(LFCliBase): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Notes for type requests + + ...examples how to call method(s) here... + Request one of these URLs: + /control/$command + + When requesting specific column names, they need to be URL Encoded. + na + + Example py-json call: + record = LFJsonGet.get_control( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + + The data returned is going to look like: + { + 'na': X + } + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + + def get_control(self, + eid_list=None, + requested_col_names='list', + debug_=False): + debug_ |= self.debug + url = "/control" + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): + for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() + if field.index(" ") > -1 : + raise ValueError("field should be URL encoded: [%s]" % (field)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) + response = self.json_get(url, debug_=debug_) + if response is None: + return None + return self.extractValues(response=response, + singular_key="", + plural_key="") + # + + + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -190,6 +273,11 @@ class LFJsonGet(LFCliBase): state, type Example URL: /cx?fields=avg+rtt,bps+rx+a + Example py-json call: + record = LFJsonGet.get_cx( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'avg rtt': X @@ -212,21 +300,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_cx(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/cx" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -254,6 +350,11 @@ class LFJsonGet(LFCliBase): sw+info, wan Example URL: /dut?fields=api+version,bssid-1 + Example py-json call: + record = LFJsonGet.get_dut( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'api version': X @@ -301,21 +402,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_dut(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/dut" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -342,9 +451,16 @@ class LFJsonGet(LFCliBase): rx+drop+%25, rx+dup+%25, rx+ooo+%25, rx+pdus, rx+pkts+ll, rx+rate, rx+rate+%281%C2%A0min%29, rx+rate+%28last%29, rx+rate+ll, rx+wrong+dev, script, send+buf, source+addr, tcp+mss, tcp+rtx, tx+bytes, tx+pdus, tx+pkts+ll, tx+rate, tx+rate+%281%C2%A0min%29, - tx+rate+%28last%29, tx+rate+ll + tx+rate+%28last%29, tx+rate+ll # hidden columns: + drop-count-5m, latency-5m, rt-latency-5m, rx-silence-5m + Example URL: /endp?fields=1st+rx,a%2Fb + Example py-json call: + record = LFJsonGet.get_endp( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { '1st rx': X @@ -407,21 +523,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_endp(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/endp" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -449,6 +573,11 @@ class LFJsonGet(LFCliBase): type Example URL: /events?fields=eid,entity+id + Example py-json call: + record = LFJsonGet.get_events( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'eid': X @@ -464,21 +593,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_events(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/events" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -504,6 +641,11 @@ class LFJsonGet(LFCliBase): status, tx-bps-20s, type, write-bps Example URL: /fileio?fields=buf-rd,buf-wr + Example py-json call: + record = LFJsonGet.get_fileio( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'buf-rd': X @@ -537,21 +679,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_fileio(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/fileio" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -576,6 +726,11 @@ class LFJsonGet(LFCliBase): tx+pkts, type Example URL: /generic?fields=bps+rx,bps+tx + Example py-json call: + record = LFJsonGet.get_generic( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'bps rx': X @@ -601,21 +756,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_generic(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/generic" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -631,11 +794,16 @@ class LFJsonGet(LFCliBase): ...examples how to call method(s) here... Request one of these URLs: - /gui-cli + /gui-cli/ When requesting specific column names, they need to be URL Encoded. na + Example py-json call: + record = LFJsonGet.get_gui_cli( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'na': X @@ -643,21 +811,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_gui_cli(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/gui-cli" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -687,6 +863,11 @@ class LFJsonGet(LFCliBase): Example URL: /layer4?fields=%21conn,acc.+denied + Example py-json call: + record = LFJsonGet.get_layer4( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { '!conn': X @@ -737,21 +918,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_layer4(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/layer4" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -792,6 +981,11 @@ class LFJsonGet(LFCliBase): Example URL: /port?fields=4way+time+%28us%29,activity + Example py-json call: + record = LFJsonGet.get_port( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { '4way time (us)': X @@ -872,21 +1066,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_port(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/port" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -897,6 +1099,61 @@ class LFJsonGet(LFCliBase): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Notes for type requests + + ...examples how to call method(s) here... + Request one of these URLs: + /quit + + When requesting specific column names, they need to be URL Encoded. + na + + Example py-json call: + record = LFJsonGet.get_quit( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + + The data returned is going to look like: + { + 'na': X + } + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + + def get_quit(self, + eid_list=None, + requested_col_names='list', + debug_=False): + debug_ |= self.debug + url = "/quit" + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): + for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() + if field.index(" ") > -1 : + raise ValueError("field should be URL encoded: [%s]" % (field)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) + response = self.json_get(url, debug_=debug_) + if response is None: + return None + return self.extractValues(response=response, + singular_key="", + plural_key="") + # + + + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -907,12 +1164,17 @@ class LFJsonGet(LFCliBase): /radiostatus/$shelf_id/$resource_id/$port_id When requesting specific column names, they need to be URL Encoded. - _links, antenna, ap, capabilities, channel, country, driver, entity+id, entity+id, - frag, frequency, max_sta, max_vap, max_vifs, monitors_up, monitors_up, phantom, - port, resource, rts, stations_down, stations_up, tx-power, vaps_down, vaps_up, - verbose+debug + _links, antenna, ap, capabilities, channel, country, driver, entity+id, firmware+version, + frag, frequency, max_sta, max_vap, max_vifs, monitors_down, monitors_up, + phantom, port, resource, rts, stations_down, stations_up, tx-power, vaps_down, + vaps_up, verbose+debug Example URL: /radiostatus?fields=_links,antenna + Example py-json call: + record = LFJsonGet.get_radiostatus( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { '_links': X @@ -923,13 +1185,13 @@ class LFJsonGet(LFCliBase): 'country': X 'driver': X 'entity id': X - 'entity id': X + 'firmware version': X 'frag': X 'frequency': X 'max_sta': X 'max_vap': X 'max_vifs': X - 'monitors_up': X + 'monitors_down': X 'monitors_up': X 'phantom': X 'port': X @@ -945,21 +1207,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_radiostatus(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/radiostatus" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -988,6 +1258,11 @@ class LFJsonGet(LFCliBase): Example URL: /resource?fields=bps-rx-3s,bps-tx-3s + Example py-json call: + record = LFJsonGet.get_resource( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'bps-rx-3s': X @@ -1019,21 +1294,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_resource(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/resource" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1062,6 +1345,11 @@ class LFJsonGet(LFCliBase): When requesting specific column names, they need to be URL Encoded. na + Example py-json call: + record = LFJsonGet.get_scan( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'na': X @@ -1069,21 +1357,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_scan(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/scan" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1108,6 +1404,11 @@ class LFJsonGet(LFCliBase): Example URL: /stations?fields=ap,auth-for + Example py-json call: + record = LFJsonGet.get_stations( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'ap': X @@ -1130,21 +1431,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_stations(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/stations" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1160,7 +1469,7 @@ class LFJsonGet(LFCliBase): ...examples how to call method(s) here... Request one of these URLs: - /status-msg + /status-msg/ /status-msg/$session /status-msg/$session/$id /status-msg/$session/$id/ws-msg,... @@ -1171,6 +1480,11 @@ class LFJsonGet(LFCliBase): When requesting specific column names, they need to be URL Encoded. na + Example py-json call: + record = LFJsonGet.get_status_msg( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'na': X @@ -1178,21 +1492,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_status_msg(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/status-msg" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1217,6 +1539,11 @@ class LFJsonGet(LFCliBase): cross+connects, entity+id, name, run, script Example URL: /test-group?fields=cross+connects,entity+id + Example py-json call: + record = LFJsonGet.get_test_group( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'cross connects': X @@ -1228,21 +1555,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_test_group(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/test-group" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1267,6 +1602,11 @@ class LFJsonGet(LFCliBase): eid, name, text, type Example URL: /text?fields=eid,name + Example py-json call: + record = LFJsonGet.get_text( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'eid': X @@ -1277,21 +1617,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_text(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/text" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1325,6 +1673,11 @@ class LFJsonGet(LFCliBase): type Example URL: /voip?fields=bps+rx+a,bps+rx+b + Example py-json call: + record = LFJsonGet.get_voip( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'bps rx a': X @@ -1348,21 +1701,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_voip(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/voip" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1389,6 +1750,11 @@ class LFJsonGet(LFCliBase): source+addr, state, tx+bytes, tx+pkts, vad+pkts Example URL: /voip-endp?fields=calls+answered,calls+attempted + Example py-json call: + record = LFJsonGet.get_voip_endp( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'calls answered': X @@ -1432,21 +1798,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_voip_endp(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/voip-endp" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1478,6 +1852,11 @@ class LFJsonGet(LFCliBase): using+bgp, using+olsr, width, x, xorp+sha, y Example URL: /vr?fields=active+ipv6+router,bgp+4byte+as + Example py-json call: + record = LFJsonGet.get_vr( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'active ipv6 router': X @@ -1519,21 +1898,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_vr(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/vr" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1558,6 +1945,11 @@ class LFJsonGet(LFCliBase): vrrp+priority, wan+link, width, x, y Example URL: /vrcx?fields=entity+id,height + Example py-json call: + record = LFJsonGet.get_vrcx( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'entity id': X @@ -1583,21 +1975,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_vrcx(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/vrcx" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1631,6 +2031,11 @@ class LFJsonGet(LFCliBase): state Example URL: /wl?fields=bps+rx+a,bps+rx+b + Example py-json call: + record = LFJsonGet.get_wl( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'bps rx a': X @@ -1648,21 +2053,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_wl(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/wl" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1689,6 +2102,11 @@ class LFJsonGet(LFCliBase): tx+pkts, tx+rate, tx-failed, wps Example URL: /wl-endp?fields=buffer,corrupt+1 + Example py-json call: + record = LFJsonGet.get_wl_endp( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'buffer': X @@ -1730,21 +2148,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_wl_endp(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/wl-endp" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1766,6 +2192,11 @@ class LFJsonGet(LFCliBase): When requesting specific column names, they need to be URL Encoded. na + Example py-json call: + record = LFJsonGet.get_ws_msg( eid_list=['1.234', '1.344'], + requested_col_names=['all'], + debug_=True) + The data returned is going to look like: { 'na': X @@ -1773,21 +2204,29 @@ class LFJsonGet(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_ws_msg(self, - shelf=1, - resource=None, - name=None, - requested_col_names=[], + eid_list=None, + requested_col_names='list', debug_=False): debug_ |= self.debug url = "/ws-msg" - if (requested_col_names is not None) and (type(requested_col_names) is not list): - raise ValueError("requested_col_names must be a None or a list") - - if (requested_col_names is not None) and (len(requested_col_names) > 0): + if (eid_list is None) or (len(eid_list) < 1): + raise ValueError("no entity id in request") + if (requested_col_names is None) or (len(requested_col_names) < 1): + raise ValueError("requested_col_names must be a list of column names, a column name, or 'list' or 'all'") + trimmed_fields = [] + if (isinstance(requested_col_names, str)): + if not requested_col_names.strip(): + raise ValueError("column name cannot be blank") + trimmed_fields.append(requested_col_names.strip()) + if (isinstance(requested_col_names, list)): for field in requested_col_names: + if not field.strip(): + raise ValueError("column names cannot be blank") + field = field.strip() if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?requested_col_names=%s" % (",".join(requested_col_names)) + trimmed_fields.append(field) + url += "?requested_col_names=%s" % (",".join(trimmed_fields)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1809,7 +2248,7 @@ class LFJsonPost(LFCliBase): _exit_on_error=False, _exit_on_fail=False, _proxy_str=None, - _capture_signal_list=[] + _capture_signal_list=None ): super().__init__(_lfjson_host=lfclient_host, _lfjson_port=lfclient_port, @@ -1827,16 +2266,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_arm_endp(self, - alias=None, - cpu_id=None, - mx_pkt_sz=None, - pkt_sz=None, - port=None, - pps=None, - resource=None, - shelf=None, - tos=None, - type=None, + alias=None, # parameter explanation pending + cpu_id=None, # parameter explanation pending + mx_pkt_sz=None, # parameter explanation pending + pkt_sz=None, # parameter explanation pending + port=None, # parameter explanation pending + pps=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + tos=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -1888,12 +2327,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_bgp_peer_flags.add_flags('bridge', 'dhcp') + add_bgp_peer_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_bgp_peer_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -1903,12 +2344,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_bgp_peer_flags.clear_flags('bridge', 'dhcp') + add_bgp_peer_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_bgp_peer_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -1919,24 +2362,24 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_bgp_peer(self, - p_as=None, - delay_open_time=None, - flags=None, - holdtime=None, - local_dev=None, - nexthop=None, - nexthop6=None, - peer_id=None, - peer_index=None, - resource=None, - shelf=None, - vr_id=None, + p_as=None, # parameter explanation pending + delay_open_time=None, # parameter explanation pending + flags=None, # parameter explanation pending + holdtime=None, # parameter explanation pending + local_dev=None, # parameter explanation pending + nexthop=None, # parameter explanation pending + nexthop6=None, # parameter explanation pending + peer_id=None, # parameter explanation pending + peer_index=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vr_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -1973,10 +2416,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_bond(self, - network_devs=None, - port=None, - resource=None, - shelf=None, + network_devs=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2007,7 +2450,7 @@ class LFJsonPost(LFCliBase): class add_br_br_flags(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_br_br_flags.clear_flags('bridge', 'dhcp') + add_br_br_flags.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_br_br_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" none = 0 # no features @@ -2015,16 +2458,16 @@ class LFJsonPost(LFCliBase): def post_add_br(self, - br_aging_time=None, - br_flags=None, - br_forwarding_delay=None, - br_hello_time=None, - br_max_age=None, - br_priority=None, - network_devs=None, - port=None, - resource=None, - shelf=None, + br_aging_time=None, # parameter explanation pending + br_flags=None, # parameter explanation pending + br_forwarding_delay=None, # parameter explanation pending + br_hello_time=None, # parameter explanation pending + br_max_age=None, # parameter explanation pending + br_priority=None, # parameter explanation pending + network_devs=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2061,7 +2504,7 @@ class LFJsonPost(LFCliBase): class add_cd_flags(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_cd_flags.clear_flags('bridge', 'dhcp') + add_cd_flags.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_cd_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" ERR = 2 # Set to kernel mode. @@ -2069,14 +2512,14 @@ class LFJsonPost(LFCliBase): def post_add_cd(self, - alias=None, - bps=None, - flags=None, - report_timer=None, - resource=None, - shelf=None, - state=None, - type=None, + alias=None, # parameter explanation pending + bps=None, # parameter explanation pending + flags=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + state=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2109,8 +2552,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_endp(self, - cd=None, - endp=None, + cd=None, # parameter explanation pending + endp=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2137,8 +2580,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_vr(self, - cd=None, - vr=None, + cd=None, # parameter explanation pending + vr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2181,12 +2624,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_chamber_chamber_flags.add_flags('bridge', 'dhcp') + add_chamber_chamber_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_chamber_chamber_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2196,12 +2641,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_chamber_chamber_flags.clear_flags('bridge', 'dhcp') + add_chamber_chamber_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_chamber_chamber_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2212,32 +2659,32 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_chamber(self, - chamber_type=None, - dut_name1=None, - dut_name2=None, - dut_name3=None, - dut_name4=None, - flags=None, - flags_mask=None, - height=None, - isolation=None, - lanforge1=None, - lanforge2=None, - lanforge3=None, - lanforge4=None, - name=None, - resource=None, - sma_count=None, - turntable_type=None, - width=None, - x=None, - y=None, + chamber_type=None, # parameter explanation pending + dut_name1=None, # parameter explanation pending + dut_name2=None, # parameter explanation pending + dut_name3=None, # parameter explanation pending + dut_name4=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + height=None, # parameter explanation pending + isolation=None, # parameter explanation pending + lanforge1=None, # parameter explanation pending + lanforge2=None, # parameter explanation pending + lanforge3=None, # parameter explanation pending + lanforge4=None, # parameter explanation pending + name=None, # parameter explanation pending + resource=None, # parameter explanation pending + sma_count=None, # parameter explanation pending + turntable_type=None, # parameter explanation pending + width=None, # parameter explanation pending + x=None, # parameter explanation pending + y=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2284,7 +2731,7 @@ class LFJsonPost(LFCliBase): class add_chamber_cx_chamber_cx_flags(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_chamber_cx_chamber_cx_flags.clear_flags('bridge', 'dhcp') + add_chamber_cx_chamber_cx_flags.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_chamber_cx_chamber_cx_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" CONNECTED = 1 # (1) Connected to something. If flag is not set, connection is open to the air (maybe with antenna) @@ -2292,17 +2739,17 @@ class LFJsonPost(LFCliBase): def post_add_chamber_cx(self, - a_id=None, - atten_id=None, - b_id=None, - connection_idx=None, - flags=None, - flags_mask=None, - internal=None, - min_atten=None, - name=None, - zrssi2=None, - zrssi5=None, + a_id=None, # parameter explanation pending + atten_id=None, # parameter explanation pending + b_id=None, # parameter explanation pending + connection_idx=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + internal=None, # parameter explanation pending + min_atten=None, # parameter explanation pending + name=None, # parameter explanation pending + zrssi2=None, # parameter explanation pending + zrssi5=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2338,9 +2785,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_chamber_path(self, - chamber=None, - content=None, - path=None, + chamber=None, # parameter explanation pending + content=None, # parameter explanation pending + path=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2370,7 +2817,7 @@ class LFJsonPost(LFCliBase): class add_channel_group_types(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_channel_group_types.clear_flags('bridge', 'dhcp') + add_channel_group_types.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_channel_group_types.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" clear = "clear" # Channel(s) are bundled into a single span. No conversion or @@ -2389,14 +2836,14 @@ class LFJsonPost(LFCliBase): def post_add_channel_group(self, - alias=None, - channels=None, - idle_flag=None, - mtu=None, - resource=None, - shelf=None, - span_num=None, - type=None, + alias=None, # parameter explanation pending + channels=None, # parameter explanation pending + idle_flag=None, # parameter explanation pending + mtu=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span_num=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2429,10 +2876,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cx(self, - alias=None, - rx_endp=None, - test_mgr=None, - tx_endp=None, + alias=None, # parameter explanation pending + rx_endp=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending + tx_endp=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2487,12 +2934,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_dut_dut_flags.add_flags('bridge', 'dhcp') + add_dut_dut_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_dut_dut_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2502,12 +2951,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_dut_dut_flags.clear_flags('bridge', 'dhcp') + add_dut_dut_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_dut_dut_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2518,40 +2969,40 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_dut(self, - antenna_count1=None, - antenna_count2=None, - antenna_count3=None, - api_id=None, - bssid1=None, - bssid2=None, - bssid3=None, - eap_id=None, - flags=None, - flags_mask=None, - hw_version=None, - img_file=None, - lan_port=None, - mgt_ip=None, - model_num=None, - name=None, - passwd1=None, - passwd2=None, - passwd3=None, - serial_num=None, - serial_port=None, - ssid1=None, - ssid2=None, - ssid3=None, - sw_version=None, - top_left_x=None, - top_left_y=None, - wan_port=None, + antenna_count1=None, # parameter explanation pending + antenna_count2=None, # parameter explanation pending + antenna_count3=None, # parameter explanation pending + api_id=None, # parameter explanation pending + bssid1=None, # parameter explanation pending + bssid2=None, # parameter explanation pending + bssid3=None, # parameter explanation pending + eap_id=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + hw_version=None, # parameter explanation pending + img_file=None, # parameter explanation pending + lan_port=None, # parameter explanation pending + mgt_ip=None, # parameter explanation pending + model_num=None, # parameter explanation pending + name=None, # parameter explanation pending + passwd1=None, # parameter explanation pending + passwd2=None, # parameter explanation pending + passwd3=None, # parameter explanation pending + serial_num=None, # parameter explanation pending + serial_port=None, # parameter explanation pending + ssid1=None, # parameter explanation pending + ssid2=None, # parameter explanation pending + ssid3=None, # parameter explanation pending + sw_version=None, # parameter explanation pending + top_left_x=None, # parameter explanation pending + top_left_y=None, # parameter explanation pending + wan_port=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2604,8 +3055,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_dut_notes(self, - dut=None, - text=None, + dut=None, # parameter explanation pending + text=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2652,12 +3103,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_dut_ssid_dut_flags.add_flags('bridge', 'dhcp') + add_dut_ssid_dut_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_dut_ssid_dut_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2667,12 +3120,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_dut_ssid_dut_flags.clear_flags('bridge', 'dhcp') + add_dut_ssid_dut_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_dut_ssid_dut_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2683,19 +3138,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_dut_ssid(self, - bssid=None, - name=None, - passwd=None, - ssid=None, - ssid_flags=None, - ssid_flags_mask=None, - ssid_idx=None, + bssid=None, # parameter explanation pending + name=None, # parameter explanation pending + passwd=None, # parameter explanation pending + ssid=None, # parameter explanation pending + ssid_flags=None, # parameter explanation pending + ssid_flags_mask=None, # parameter explanation pending + ssid_idx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2729,7 +3184,7 @@ class LFJsonPost(LFCliBase): class add_endp_payload_pattern(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_endp_payload_pattern.clear_flags('bridge', 'dhcp') + add_endp_payload_pattern.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_endp_payload_pattern.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" PRBS_11_8_10 = "PRBS_11_8_10" # PRBS (see above) @@ -2747,7 +3202,7 @@ class LFJsonPost(LFCliBase): class add_endp_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_endp_type.clear_flags('bridge', 'dhcp') + add_endp_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_endp_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" custom_ether = "custom_ether" # LF frames with custom options, use with playback @@ -2765,23 +3220,23 @@ class LFJsonPost(LFCliBase): def post_add_endp(self, - alias=None, - ip_port=None, - is_pkt_sz_random=None, - is_rate_bursty=None, - max_pkt=None, - max_rate=None, - min_pkt=None, - min_rate=None, - multi_conn=None, - payload_pattern=None, - port=None, - resource=None, - send_bad_crc_per_million=None, - shelf=None, - ttl=None, - type=None, - use_checksum=None, + alias=None, # parameter explanation pending + ip_port=None, # parameter explanation pending + is_pkt_sz_random=None, # parameter explanation pending + is_rate_bursty=None, # parameter explanation pending + max_pkt=None, # parameter explanation pending + max_rate=None, # parameter explanation pending + min_pkt=None, # parameter explanation pending + min_rate=None, # parameter explanation pending + multi_conn=None, # parameter explanation pending + payload_pattern=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + send_bad_crc_per_million=None, # parameter explanation pending + shelf=None, # parameter explanation pending + ttl=None, # parameter explanation pending + type=None, # parameter explanation pending + use_checksum=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2823,10 +3278,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_event(self, - details=None, - event_id=None, - name=None, - priority=None, + details=None, # parameter explanation pending + event_id=None, # parameter explanation pending + name=None, # parameter explanation pending + priority=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2878,12 +3333,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_file_endp_fio_flags.add_flags('bridge', 'dhcp') + add_file_endp_fio_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_file_endp_fio_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2893,12 +3350,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_file_endp_fio_flags.clear_flags('bridge', 'dhcp') + add_file_endp_fio_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_file_endp_fio_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -2909,14 +3368,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class add_file_endp_payload_pattern(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_file_endp_payload_pattern.clear_flags('bridge', 'dhcp') + add_file_endp_payload_pattern.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_file_endp_payload_pattern.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" PRBS_11_8_10 = "PRBS_11_8_10" # PRBS (see above) @@ -2933,24 +3392,24 @@ class LFJsonPost(LFCliBase): def post_add_file_endp(self, - alias=None, - directory=None, - fio_flags=None, - max_read_rate=None, - max_write_rate=None, - min_read_rate=None, - min_write_rate=None, - mount_dir=None, - mount_options=None, - payload_pattern=None, - port=None, - prefix=None, - resource=None, - retry_timer=None, - server_mount=None, - shelf=None, - type=None, - volume=None, + alias=None, # parameter explanation pending + directory=None, # parameter explanation pending + fio_flags=None, # parameter explanation pending + max_read_rate=None, # parameter explanation pending + max_write_rate=None, # parameter explanation pending + min_read_rate=None, # parameter explanation pending + min_write_rate=None, # parameter explanation pending + mount_dir=None, # parameter explanation pending + mount_options=None, # parameter explanation pending + payload_pattern=None, # parameter explanation pending + port=None, # parameter explanation pending + prefix=None, # parameter explanation pending + resource=None, # parameter explanation pending + retry_timer=None, # parameter explanation pending + server_mount=None, # parameter explanation pending + shelf=None, # parameter explanation pending + type=None, # parameter explanation pending + volume=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2993,11 +3452,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_gen_endp(self, - alias=None, - port=None, - resource=None, - shelf=None, - type=None, + alias=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3027,12 +3486,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_gre(self, - local_lower_ip=None, - port=None, - remote_lower_ip=None, - report_timer=None, - resource=None, - shelf=None, + local_lower_ip=None, # parameter explanation pending + port=None, # parameter explanation pending + remote_lower_ip=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3077,12 +3536,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_group_flags.add_flags('bridge', 'dhcp') + add_group_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_group_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3092,12 +3553,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_group_flags.clear_flags('bridge', 'dhcp') + add_group_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_group_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3108,15 +3571,15 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_group(self, - flags=None, - flags_mask=None, - name=None, + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3161,12 +3624,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_http_auth_type.add_flags('bridge', 'dhcp') + add_l4_endp_http_auth_type.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_l4_endp_http_auth_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3176,12 +3641,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_http_auth_type.clear_flags('bridge', 'dhcp') + add_l4_endp_http_auth_type.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_l4_endp_http_auth_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3192,7 +3659,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -3222,12 +3689,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_proxy_auth_type.add_flags('bridge', 'dhcp') + add_l4_endp_proxy_auth_type.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_l4_endp_proxy_auth_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3237,12 +3706,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_proxy_auth_type.clear_flags('bridge', 'dhcp') + add_l4_endp_proxy_auth_type.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_l4_endp_proxy_auth_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3253,7 +3724,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -3272,12 +3743,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_type.add_flags('bridge', 'dhcp') + add_l4_endp_type.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_l4_endp_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3287,12 +3760,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_l4_endp_type.clear_flags('bridge', 'dhcp') + add_l4_endp_type.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_l4_endp_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3303,33 +3778,33 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_l4_endp(self, - alias=None, - block_size=None, - dns_cache_timeout=None, - http_auth_type=None, - ip_addr=None, - max_speed=None, - port=None, - proxy_auth_type=None, - proxy_port=None, - proxy_server=None, - proxy_userpwd=None, - quiesce_after=None, - resource=None, - shelf=None, - smtp_from=None, - ssl_cert_fname=None, - timeout=None, - type=None, - url=None, - url_rate=None, - user_agent=None, + alias=None, # parameter explanation pending + block_size=None, # parameter explanation pending + dns_cache_timeout=None, # parameter explanation pending + http_auth_type=None, # parameter explanation pending + ip_addr=None, # parameter explanation pending + max_speed=None, # parameter explanation pending + port=None, # parameter explanation pending + proxy_auth_type=None, # parameter explanation pending + proxy_port=None, # parameter explanation pending + proxy_server=None, # parameter explanation pending + proxy_userpwd=None, # parameter explanation pending + quiesce_after=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + smtp_from=None, # parameter explanation pending + ssl_cert_fname=None, # parameter explanation pending + timeout=None, # parameter explanation pending + type=None, # parameter explanation pending + url=None, # parameter explanation pending + url_rate=None, # parameter explanation pending + user_agent=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3391,12 +3866,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_monitor_flags.add_flags('bridge', 'dhcp') + add_monitor_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_monitor_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3406,12 +3883,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_monitor_flags.clear_flags('bridge', 'dhcp') + add_monitor_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_monitor_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3422,20 +3901,20 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_monitor(self, - aid=None, - ap_name=None, - bssid=None, - flags=None, - flags_mask=None, - radio=None, - resource=None, - shelf=None, + aid=None, # parameter explanation pending + ap_name=None, # parameter explanation pending + bssid=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + radio=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3468,14 +3947,14 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_mvlan(self, - flags=None, - index=None, - mac=None, - old_name=None, - port=None, - report_timer=None, - resource=None, - shelf=None, + flags=None, # parameter explanation pending + index=None, # parameter explanation pending + mac=None, # parameter explanation pending + old_name=None, # parameter explanation pending + port=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3508,27 +3987,27 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_ppp_link(self, - auth=None, - channel_groups=None, - debug=None, - down_time_max_ms=None, - down_time_min_ms=None, - dst_ip=None, - extra_args=None, - holdoff=None, - lcp_echo_failure=None, - lcp_echo_interval=None, - mlppp_descriptor=None, - persist=None, - pppoe_transport_port=None, - resource=None, - run_time_max_ms=None, - run_time_min_ms=None, - shelf=None, - src_ip=None, - transport_type=None, - tty_transport_device=None, - unit=None, + auth=None, # parameter explanation pending + channel_groups=None, # parameter explanation pending + debug=None, # parameter explanation pending + down_time_max_ms=None, # parameter explanation pending + down_time_min_ms=None, # parameter explanation pending + dst_ip=None, # parameter explanation pending + extra_args=None, # parameter explanation pending + holdoff=None, # parameter explanation pending + lcp_echo_failure=None, # parameter explanation pending + lcp_echo_interval=None, # parameter explanation pending + mlppp_descriptor=None, # parameter explanation pending + persist=None, # parameter explanation pending + pppoe_transport_port=None, # parameter explanation pending + resource=None, # parameter explanation pending + run_time_max_ms=None, # parameter explanation pending + run_time_min_ms=None, # parameter explanation pending + shelf=None, # parameter explanation pending + src_ip=None, # parameter explanation pending + transport_type=None, # parameter explanation pending + tty_transport_device=None, # parameter explanation pending + unit=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3598,12 +4077,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_profile_profile_flags.add_flags('bridge', 'dhcp') + add_profile_profile_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_profile_profile_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3613,12 +4094,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_profile_profile_flags.clear_flags('bridge', 'dhcp') + add_profile_profile_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_profile_profile_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3629,18 +4112,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class add_profile_wifi_mode(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_profile_wifi_mode.clear_flags('bridge', 'dhcp') + add_profile_wifi_mode.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_profile_wifi_mode.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_802_11a = "802.11a" # 802.11a AUTO = "AUTO" # 802.11g + aAX = "aAX" # 802.11a-AX (6E disables /n and /ac) abg = "abg" # 802.11abg abgn = "abgn" # 802.11abgn abgnAC = "abgnAC" # 802.11abgn-AC @@ -3670,21 +4154,21 @@ class LFJsonPost(LFCliBase): def post_add_profile(self, - alias_prefix=None, - antenna=None, - bandwidth=None, - eap_id=None, - flags_mask=None, - freq=None, - instance_count=None, - mac_pattern=None, - name=None, - passwd=None, - profile_flags=None, - profile_type=None, - ssid=None, - vid=None, - wifi_mode=None, + alias_prefix=None, # parameter explanation pending + antenna=None, # parameter explanation pending + bandwidth=None, # parameter explanation pending + eap_id=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + freq=None, # parameter explanation pending + instance_count=None, # parameter explanation pending + mac_pattern=None, # parameter explanation pending + name=None, # parameter explanation pending + passwd=None, # parameter explanation pending + profile_flags=None, # parameter explanation pending + profile_type=None, # parameter explanation pending + ssid=None, # parameter explanation pending + vid=None, # parameter explanation pending + wifi_mode=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3724,8 +4208,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_profile_notes(self, - dut=None, - text=None, + dut=None, # parameter explanation pending + text=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3752,11 +4236,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_rdd(self, - peer_ifname=None, - port=None, - report_timer=None, - resource=None, - shelf=None, + peer_ifname=None, # parameter explanation pending + port=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3786,10 +4270,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3866,12 +4350,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_sta_flags.add_flags('bridge', 'dhcp') + add_sta_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_sta_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3881,12 +4367,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_sta_flags.clear_flags('bridge', 'dhcp') + add_sta_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_sta_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -3897,18 +4385,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class add_sta_mode(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_sta_mode.clear_flags('bridge', 'dhcp') + add_sta_mode.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_sta_mode.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_802_11a = 1 # 802.11a AUTO = 0 # 802.11g + aAX = 15 # 802.11a-AX (6E disables /n and /ac) abg = 4 # 802.11abg abgn = 5 # 802.11abgn abgnAC = 8 # 802.11abgn-AC @@ -3926,7 +4415,7 @@ class LFJsonPost(LFCliBase): class add_sta_rate(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_sta_rate.clear_flags('bridge', 'dhcp') + add_sta_rate.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_sta_rate.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_a_g = "/a/g" # 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, 54 Mbps @@ -3937,28 +4426,28 @@ class LFJsonPost(LFCliBase): def post_add_sta(self, - ampdu_density=None, - ampdu_factor=None, - ap=None, - flags=None, - flags_mask=None, - ieee80211w=None, - key=None, - mac=None, - max_amsdu=None, - mode=None, - nickname=None, - radio=None, - rate=None, - resource=None, - shelf=None, - ssid=None, - sta_br_ip=None, - sta_name=None, - wpa_cfg_file=None, - x_coord=None, - y_coord=None, - z_coord=None, + ampdu_density=None, # parameter explanation pending + ampdu_factor=None, # parameter explanation pending + ap=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + ieee80211w=None, # parameter explanation pending + key=None, # parameter explanation pending + mac=None, # parameter explanation pending + max_amsdu=None, # parameter explanation pending + mode=None, # parameter explanation pending + nickname=None, # parameter explanation pending + radio=None, # parameter explanation pending + rate=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + ssid=None, # parameter explanation pending + sta_br_ip=None, # parameter explanation pending + sta_name=None, # parameter explanation pending + wpa_cfg_file=None, # parameter explanation pending + x_coord=None, # parameter explanation pending + y_coord=None, # parameter explanation pending + z_coord=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4007,7 +4496,7 @@ class LFJsonPost(LFCliBase): class add_t1_span_buildout(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_t1_span_buildout.clear_flags('bridge', 'dhcp') + add_t1_span_buildout.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_t1_span_buildout.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_15db = 6 # -15db (CSU) @@ -4022,19 +4511,19 @@ class LFJsonPost(LFCliBase): def post_add_t1_span(self, - buildout=None, - coding=None, - cpu_id=None, - first_channel=None, - framing=None, - mtu=None, - pci_bus=None, - pci_slot=None, - resource=None, - shelf=None, - span_num=None, - timing=None, - type=None, + buildout=None, # parameter explanation pending + coding=None, # parameter explanation pending + cpu_id=None, # parameter explanation pending + first_channel=None, # parameter explanation pending + framing=None, # parameter explanation pending + mtu=None, # parameter explanation pending + pci_bus=None, # parameter explanation pending + pci_slot=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span_num=None, # parameter explanation pending + timing=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4072,9 +4561,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_text_blob(self, - name=None, - text=None, - type=None, + name=None, # parameter explanation pending + text=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4102,8 +4591,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tgcx(self, - cxname=None, - tgname=None, + cxname=None, # parameter explanation pending + tgname=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4132,7 +4621,7 @@ class LFJsonPost(LFCliBase): class add_threshold_thresh_id(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_threshold_thresh_id.clear_flags('bridge', 'dhcp') + add_threshold_thresh_id.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_threshold_thresh_id.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Delete_Marked = -3 # Delete any marked. @@ -4141,7 +4630,7 @@ class LFJsonPost(LFCliBase): class add_threshold_thresh_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_threshold_thresh_type.clear_flags('bridge', 'dhcp') + add_threshold_thresh_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_threshold_thresh_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NO_RX_SINCE = 6 # Have not received any bytes/packets in specified time. @@ -4156,11 +4645,11 @@ class LFJsonPost(LFCliBase): def post_add_threshold(self, - endp=None, - thresh_id=None, - thresh_max=None, - thresh_min=None, - thresh_type=None, + endp=None, # parameter explanation pending + thresh_id=None, # parameter explanation pending + thresh_max=None, # parameter explanation pending + thresh_min=None, # parameter explanation pending + thresh_type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4190,7 +4679,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tm(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4232,12 +4721,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_traffic_profile_traffic_profile_flags.add_flags('bridge', 'dhcp') + add_traffic_profile_traffic_profile_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_traffic_profile_traffic_profile_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4247,12 +4738,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_traffic_profile_traffic_profile_flags.clear_flags('bridge', 'dhcp') + add_traffic_profile_traffic_profile_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_traffic_profile_traffic_profile_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4263,14 +4756,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class add_traffic_profile_wifi_mode(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_traffic_profile_wifi_mode.clear_flags('bridge', 'dhcp') + add_traffic_profile_wifi_mode.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_traffic_profile_wifi_mode.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Iperf3_Client = "Iperf3-Client" # iperf3 client @@ -4283,16 +4776,16 @@ class LFJsonPost(LFCliBase): def post_add_traffic_profile(self, - instance_count=None, - max_pdu=None, - max_speed=None, - min_pdu=None, - min_speed=None, - name=None, - tos=None, - traffic_profile_flags=None, - traffic_profile_flags_mask=None, - type=None, + instance_count=None, # parameter explanation pending + max_pdu=None, # parameter explanation pending + max_speed=None, # parameter explanation pending + min_pdu=None, # parameter explanation pending + min_speed=None, # parameter explanation pending + name=None, # parameter explanation pending + tos=None, # parameter explanation pending + traffic_profile_flags=None, # parameter explanation pending + traffic_profile_flags_mask=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4327,8 +4820,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_traffic_profile_notes(self, - dut=None, - text=None, + dut=None, # parameter explanation pending + text=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4396,12 +4889,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vap_flags.add_flags('bridge', 'dhcp') + add_vap_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_vap_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4411,12 +4906,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vap_flags.clear_flags('bridge', 'dhcp') + add_vap_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_vap_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4427,25 +4924,26 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class add_vap_mode(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vap_mode.clear_flags('bridge', 'dhcp') + add_vap_mode.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_vap_mode.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_802_11a = 1 # 802.11a AUTO = 0 # 802.11g + aAX = 15 # 802.11a-AX (6E disables /n and /ac) abg = 4 # 802.11abg abgn = 5 # 802.11abgn abgnAC = 8 # 802.11abgn-AC abgnAX = 12 # 802.11abgn-AX an = 10 # 802.11an anAC = 9 # 802.11an-AC - anAX = 14 # 802.11an-AXAUTO | 0 # + anAX = 14 # 802.11an-AX b = 2 # 802.11b bg = 7 # 802.11bg bgn = 6 # 802.11bgn @@ -4455,26 +4953,26 @@ class LFJsonPost(LFCliBase): def post_add_vap(self, - ap_name=None, - beacon=None, - custom_cfg=None, - dtim_period=None, - flags=None, - flags_mask=None, - frag_thresh=None, - ieee80211w=None, - key=None, - mac=None, - max_sta=None, - mode=None, - radio=None, - rate=None, - resource=None, - shelf=None, - ssid=None, - x_coord=None, - y_coord=None, - z_coord=None, + ap_name=None, # parameter explanation pending + beacon=None, # parameter explanation pending + custom_cfg=None, # parameter explanation pending + dtim_period=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + frag_thresh=None, # parameter explanation pending + ieee80211w=None, # parameter explanation pending + key=None, # parameter explanation pending + mac=None, # parameter explanation pending + max_sta=None, # parameter explanation pending + mode=None, # parameter explanation pending + radio=None, # parameter explanation pending + rate=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + ssid=None, # parameter explanation pending + x_coord=None, # parameter explanation pending + y_coord=None, # parameter explanation pending + z_coord=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4536,12 +5034,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_venue_freq_24.add_flags('bridge', 'dhcp') + add_venue_freq_24.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_venue_freq_24.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4551,12 +5051,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_venue_freq_24.clear_flags('bridge', 'dhcp') + add_venue_freq_24.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_venue_freq_24.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4567,7 +5069,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -4612,12 +5114,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_venue_freq_5.add_flags('bridge', 'dhcp') + add_venue_freq_5.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_venue_freq_5.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4627,12 +5131,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_venue_freq_5.clear_flags('bridge', 'dhcp') + add_venue_freq_5.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_venue_freq_5.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4643,22 +5149,22 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_venue(self, - description=None, - freq_24=None, - freq_5=None, - resource=None, - shelf=None, - venu_id=None, - x1=None, - x2=None, - y1=None, - y2=None, + description=None, # parameter explanation pending + freq_24=None, # parameter explanation pending + freq_5=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + venu_id=None, # parameter explanation pending + x1=None, # parameter explanation pending + x2=None, # parameter explanation pending + y1=None, # parameter explanation pending + y2=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4693,12 +5199,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vlan(self, - old_name=None, - port=None, - report_timer=None, - resource=None, - shelf=None, - vid=None, + old_name=None, # parameter explanation pending + port=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vid=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4729,23 +5235,23 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_voip_endp(self, - alias=None, - auth_user_name=None, - display_name=None, - gateway_port=None, - ip_addr=None, - peer_phone_num=None, - phone_num=None, - port=None, - proxy_passwd=None, - resource=None, - rtp_port=None, - rx_sound_file=None, - shelf=None, - sip_gateway=None, - tx_sound_file=None, - vad_max_timer=None, - vad_timer=None, + alias=None, # parameter explanation pending + auth_user_name=None, # parameter explanation pending + display_name=None, # parameter explanation pending + gateway_port=None, # parameter explanation pending + ip_addr=None, # parameter explanation pending + peer_phone_num=None, # parameter explanation pending + phone_num=None, # parameter explanation pending + port=None, # parameter explanation pending + proxy_passwd=None, # parameter explanation pending + resource=None, # parameter explanation pending + rtp_port=None, # parameter explanation pending + rx_sound_file=None, # parameter explanation pending + shelf=None, # parameter explanation pending + sip_gateway=None, # parameter explanation pending + tx_sound_file=None, # parameter explanation pending + vad_max_timer=None, # parameter explanation pending + vad_timer=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4813,12 +5319,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vr_flags.add_flags('bridge', 'dhcp') + add_vr_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_vr_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4828,12 +5336,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vr_flags.clear_flags('bridge', 'dhcp') + add_vr_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_vr_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4844,22 +5354,22 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_vr(self, - alias=None, - flags=None, - height=None, - notes=None, - resource=None, - shelf=None, - vr_id=None, - width=None, - x=None, - y=None, + alias=None, # parameter explanation pending + flags=None, # parameter explanation pending + height=None, # parameter explanation pending + notes=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vr_id=None, # parameter explanation pending + width=None, # parameter explanation pending + x=None, # parameter explanation pending + y=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4912,12 +5422,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vr_bgp_flags.add_flags('bridge', 'dhcp') + add_vr_bgp_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_vr_bgp_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4927,12 +5439,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vr_bgp_flags.clear_flags('bridge', 'dhcp') + add_vr_bgp_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_vr_bgp_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -4943,24 +5457,24 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_vr_bgp(self, - bgp_id=None, - cluster_id=None, - confed_id=None, - flags=None, - half_life=None, - local_as=None, - max_suppress=None, - resource=None, - reuse=None, - shelf=None, - suppress=None, - vr_id=None, + bgp_id=None, # parameter explanation pending + cluster_id=None, # parameter explanation pending + confed_id=None, # parameter explanation pending + flags=None, # parameter explanation pending + half_life=None, # parameter explanation pending + local_as=None, # parameter explanation pending + max_suppress=None, # parameter explanation pending + resource=None, # parameter explanation pending + reuse=None, # parameter explanation pending + shelf=None, # parameter explanation pending + suppress=None, # parameter explanation pending + vr_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5024,12 +5538,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vrcx_flags.add_flags('bridge', 'dhcp') + add_vrcx_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+add_vrcx_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -5039,12 +5555,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_vrcx_flags.clear_flags('bridge', 'dhcp') + add_vrcx_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+add_vrcx_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -5055,43 +5573,43 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_add_vrcx(self, - dhcp_dns=None, - dhcp_dns6=None, - dhcp_domain=None, - dhcp_lease_time=None, - dhcp_max=None, - dhcp_max6=None, - dhcp_min=None, - dhcp_min6=None, - flags=None, - height=None, - interface_cost=None, - local_dev=None, - local_dev_b=None, - nexthop=None, - ospf_area=None, - remote_dev=None, - remote_dev_b=None, - resource=None, - rip_metric=None, - shelf=None, - subnets=None, - vr_name=None, - vrrp_id=None, - vrrp_interval=None, - vrrp_ip=None, - vrrp_ip_prefix=None, - vrrp_priority=None, - wanlink=None, - width=None, - x=None, - y=None, + dhcp_dns=None, # parameter explanation pending + dhcp_dns6=None, # parameter explanation pending + dhcp_domain=None, # parameter explanation pending + dhcp_lease_time=None, # parameter explanation pending + dhcp_max=None, # parameter explanation pending + dhcp_max6=None, # parameter explanation pending + dhcp_min=None, # parameter explanation pending + dhcp_min6=None, # parameter explanation pending + flags=None, # parameter explanation pending + height=None, # parameter explanation pending + interface_cost=None, # parameter explanation pending + local_dev=None, # parameter explanation pending + local_dev_b=None, # parameter explanation pending + nexthop=None, # parameter explanation pending + ospf_area=None, # parameter explanation pending + remote_dev=None, # parameter explanation pending + remote_dev_b=None, # parameter explanation pending + resource=None, # parameter explanation pending + rip_metric=None, # parameter explanation pending + shelf=None, # parameter explanation pending + subnets=None, # parameter explanation pending + vr_name=None, # parameter explanation pending + vrrp_id=None, # parameter explanation pending + vrrp_interval=None, # parameter explanation pending + vrrp_ip=None, # parameter explanation pending + vrrp_ip_prefix=None, # parameter explanation pending + vrrp_priority=None, # parameter explanation pending + wanlink=None, # parameter explanation pending + width=None, # parameter explanation pending + x=None, # parameter explanation pending + y=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5147,12 +5665,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vrcx2(self, - local_dev=None, - nexthop6=None, - resource=None, - shelf=None, - subnets6=None, - vr_name=None, + local_dev=None, # parameter explanation pending + nexthop6=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + subnets6=None, # parameter explanation pending + vr_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5176,193 +5694,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#add_sta - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - class add_sta_flags(IntFlag): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - selected_named_flag_map = {} - temp_flag_value = 0x0 - - p_80211r_pmska_cache = 0x4000000 # Enable oportunistic PMSKA caching for WPA2 (Related to 802.11r). - p_80211u_additional = 0x100000 # AP requires additional step for access (802.11u Interworking) - p_80211u_auto = 0x40000 # Enable 802.11u (Interworking) Auto-internetworking feature. Always enabled currently. - p_80211u_e911 = 0x200000 # AP claims emergency services reachable (802.11u Interworking) - p_80211u_e911_unauth = 0x400000 # AP provides Unauthenticated emergency services (802.11u Interworking) - p_80211u_enable = 0x20000 # Enable 802.11u (Interworking) feature. - p_80211u_gw = 0x80000 # AP Provides access to internet (802.11u Interworking) - p_8021x_radius = 0x2000000 # Use 802.1x (RADIUS for AP). - create_admin_down = 0x1000000000 # Station should be created admin-down. - custom_conf = 0x20 # Use Custom wpa_supplicant config file. - disable_twt = 0x100000000000 # Disable TWT mode - disable_fast_reauth = 0x200000000 # Disable fast_reauth option for virtual stations. - disable_gdaf = 0x1000000 # AP: Disable DGAF (used by HotSpot 2.0). - disable_ht80 = 0x8000000 # Disable HT80 (for AC chipset NICs only) - disable_roam = 0x80000000 # Disable automatic station roaming based on scan results. - disable_sgi = 0x4000 # Disable SGI (Short Guard Interval). - hs20_enable = 0x800000 # Enable Hotspot 2.0 (HS20) feature. Requires WPA-2. - ht160_enable = 0x100000000 # Enable HT160 mode. - ht40_disable = 0x800 # Disable HT-40 even if hardware and AP support it. - ibss_mode = 0x20000000 # Station should be in IBSS mode. - lf_sta_migrate = 0x8000 # OK-To-Migrate (Allow station migration between LANforge radios) - mesh_mode = 0x400000000 # Station should be in MESH mode. - no_supp_op_class_ie = 0x4000000000 # Do not include supported-oper-class-IE in assoc requests. May work around AP bugs. - osen_enable = 0x40000000 # Enable OSEN protocol (OSU Server-only Authentication) - passive_scan = 0x2000 # Use passive scanning (don't send probe requests). - power_save_enable = 0x800000000 # Station should enable power-save. May not work in all drivers/configurations. - scan_ssid = 0x1000 # Enable SCAN-SSID flag in wpa_supplicant. - txo_enable = 0x8000000000 # Enable/disable tx-offloads, typically managed by set_wifi_txo command - use_bss_transition = 0x80000000000 # Enable BSS transition. - use_wpa3 = 0x10000000000 # Enable WPA-3 (SAE Personal) mode. - verbose = 0x10000 # Verbose-Debug: Increase debug info in wpa-supplicant and hostapd logs. - wds_mode = 0x2000000000 # WDS station (sort of like a lame mesh), not supported on ath10k - wep_enable = 0x200 # Use wpa_supplicant configured for WEP encryption. - wpa2_enable = 0x400 # Use wpa_supplicant configured for WPA2 encryption. - wpa_enable = 0x10 # Enable WPA - - # (internal method) call this from add_flags() or remove_flags() - def update_flag_value(self): - self.temp_flag_value = 0x0 - for flag in self.selected_named_flag_map.keys(): - self.temp_flag_value |= flag.value - - def add_flags(self, flag_names=[]): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - add_sta_flags.add_flags('bridge', 'dhcp') - print('value now: '+add_sta_flags.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - if type(flag_names) is list: - for flag in (flag_names): - if flag is None: - continue - self.selected_named_flag_map.put(flag, 0) - elif flag_names is not None: - self.selected_named_flag_map.put(flag_names, 0) - self.update_flag_value() - - def clear_flags(self, flag_names=[]): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - add_sta_flags.clear_flags('bridge', 'dhcp') - print( 'value now: '+add_sta_flags.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - if type(flag_names) is list: - for flag in (flag_names): - if flag is None: - continue - if self.selected_named_flag_map.contains(flag): - self.selected_named_flag_map.remove(flag) - elif (flag_names is not None) and self.selected_named_flag_map.contains(flag_names): - self.selected_named_flag_map.remove(flag_names) - self.update_flag_value() - - def value(self, flag_names=[]): - return self.temp_flag_value - - - class add_sta_mode(Enum): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - add_sta_mode.clear_flags('bridge', 'dhcp') - print( 'value now: '+add_sta_mode.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - p_802_11a = 1 # 802.11a - AUTO = 0 # 802.11g - abg = 4 # 802.11abg - abgn = 5 # 802.11abgn - abgnAC = 8 # 802.11abgn-AC - abgnAX = 12 # 802.11abgn-AX - an = 10 # 802.11an - anAC = 9 # 802.11an-AC - anAX = 14 # 802.11an-AX - b = 2 # 802.11b - bg = 7 # 802.11bg - bgn = 6 # 802.11bgn - bgnAC = 11 # 802.11bgn-AC - bgnAX = 13 # 802.11bgn-AX - g = 3 # 802.11g - - class add_sta_rate(Enum): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - add_sta_rate.clear_flags('bridge', 'dhcp') - print( 'value now: '+add_sta_rate.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - p_a_g = "/a/g" # 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, 54 Mbps - p_b = "/b" # 1Mbps, 2Mbps, 5.5 Mbps, 11 Mbps - DEFAULT = "DEFAULT" # Use maximum available speed - MCS0_76 = "MCS0-76" # /n rates - p_bitmap_ = "[bitmap]" # '0xff 00 ...' to directly specify the MCS bitmap. - - - def post_add_vsta(self, - ampdu_density=None, - ampdu_factor=None, - ap=None, - flags=None, - flags_mask=None, - ieee80211w=None, - key=None, - mac=None, - max_amsdu=None, - mode=None, - nickname=None, - radio=None, - rate=None, - resource=None, - shelf=None, - ssid=None, - sta_br_ip=None, - sta_name=None, - wpa_cfg_file=None, - x_coord=None, - y_coord=None, - z_coord=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_add_vsta(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "ampdu_density" : ampdu_density, - "ampdu_factor" : ampdu_factor, - "ap" : ap, - "flags" : flags, - "flags_mask" : flags_mask, - "ieee80211w" : ieee80211w, - "key" : key, - "mac" : mac, - "max_amsdu" : max_amsdu, - "mode" : mode, - "nickname" : nickname, - "radio" : radio, - "rate" : rate, - "resource" : resource, - "shelf" : shelf, - "ssid" : ssid, - "sta_br_ip" : sta_br_ip, - "sta_name" : sta_name, - "wpa_cfg_file" : wpa_cfg_file, - "x_coord" : x_coord, - "y_coord" : y_coord, - "z_coord" : z_coord, - } - response = self.json_post("/cli-json/add_vsta", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -5372,50 +5703,50 @@ class LFJsonPost(LFCliBase): class add_wl_endp_wle_flags(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - add_wl_endp_wle_flags.clear_flags('bridge', 'dhcp') + add_wl_endp_wle_flags.clear_flags(['bridge', 'dhcp']) print( 'value now: '+add_wl_endp_wle_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" SHOW_WP = 1 # Show WanPaths in wanlink endpoint table in GUI def post_add_wl_endp(self, - alias=None, - cpu_id=None, - description=None, - dest_ip=None, - dest_ip_mask=None, - drop_every_xth_pkt=None, - drop_freq=None, - dup_every_xth_pkt=None, - dup_freq=None, - extra_buffer=None, - ignore_bandwidth=None, - ignore_dup=None, - ignore_latency=None, - ignore_loss=None, - jitter_freq=None, - latency=None, - max_drop_amt=None, - max_jitter=None, - max_lateness=None, - max_rate=None, - max_reorder_amt=None, - min_drop_amt=None, - min_reorder_amt=None, - playback_capture=None, - playback_capture_file=None, - playback_loop=None, - port=None, - reorder_every_xth_pkt=None, - reorder_freq=None, - resource=None, - shelf=None, - source_ip=None, - source_ip_mask=None, - speed=None, - test_mgr=None, - wanlink=None, - wle_flags=None, + alias=None, # parameter explanation pending + cpu_id=None, # parameter explanation pending + description=None, # parameter explanation pending + dest_ip=None, # parameter explanation pending + dest_ip_mask=None, # parameter explanation pending + drop_every_xth_pkt=None, # parameter explanation pending + drop_freq=None, # parameter explanation pending + dup_every_xth_pkt=None, # parameter explanation pending + dup_freq=None, # parameter explanation pending + extra_buffer=None, # parameter explanation pending + ignore_bandwidth=None, # parameter explanation pending + ignore_dup=None, # parameter explanation pending + ignore_latency=None, # parameter explanation pending + ignore_loss=None, # parameter explanation pending + jitter_freq=None, # parameter explanation pending + latency=None, # parameter explanation pending + max_drop_amt=None, # parameter explanation pending + max_jitter=None, # parameter explanation pending + max_lateness=None, # parameter explanation pending + max_rate=None, # parameter explanation pending + max_reorder_amt=None, # parameter explanation pending + min_drop_amt=None, # parameter explanation pending + min_reorder_amt=None, # parameter explanation pending + playback_capture=None, # parameter explanation pending + playback_capture_file=None, # parameter explanation pending + playback_loop=None, # parameter explanation pending + port=None, # parameter explanation pending + reorder_every_xth_pkt=None, # parameter explanation pending + reorder_freq=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + source_ip=None, # parameter explanation pending + source_ip_mask=None, # parameter explanation pending + speed=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending + wanlink=None, # parameter explanation pending + wle_flags=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5477,11 +5808,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_admin(self, - arg1=None, - arg2=None, - arg3=None, - arg5=None, - cmd=None, + arg1=None, # parameter explanation pending + arg2=None, # parameter explanation pending + arg3=None, # parameter explanation pending + arg5=None, # parameter explanation pending + cmd=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5511,8 +5842,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_apply_vr_cfg(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5539,9 +5870,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_blink_attenuator(self, - resource=None, - serno=None, - shelf=None, + resource=None, # parameter explanation pending + serno=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5589,12 +5920,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - c_show_ports_probe_flags.add_flags('bridge', 'dhcp') + c_show_ports_probe_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+c_show_ports_probe_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -5604,12 +5937,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - c_show_ports_probe_flags.clear_flags('bridge', 'dhcp') + c_show_ports_probe_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+c_show_ports_probe_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -5620,16 +5955,16 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_c_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, # parameter explanation pending + probe_flags=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5658,8 +5993,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_cancel_vr_cfg(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5679,34 +6014,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#clear_resource_counters - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_clear_card_counters(self, - resource=None, - shelf=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_clear_card_counters(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "resource" : resource, - "shelf" : shelf, - } - response = self.json_post("/cli-json/clear_card_counters", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -5714,7 +6021,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cd_counters(self, - cd_name=None, + cd_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5740,7 +6047,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cx_counters(self, - cx_name=None, + cx_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5766,9 +6073,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_endp_counters(self, - endp_name=None, - incr_seqno=None, - just_latency=None, + endp_name=None, # parameter explanation pending + incr_seqno=None, # parameter explanation pending + just_latency=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5796,7 +6103,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_group(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5824,7 +6131,7 @@ class LFJsonPost(LFCliBase): class clear_port_counters_extra(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - clear_port_counters_extra.clear_flags('bridge', 'dhcp') + clear_port_counters_extra.clear_flags(['bridge', 'dhcp']) print( 'value now: '+clear_port_counters_extra.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" dhcp4_lease = "dhcp4_lease" # Remove dhcp lease files for IPv4 DHCP @@ -5833,10 +6140,10 @@ class LFJsonPost(LFCliBase): def post_clear_port_counters(self, - extra=None, - port=None, - resource=None, - shelf=None, + extra=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5865,8 +6172,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_resource_counters(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5893,8 +6200,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_wp_counters(self, - endp_name=None, - wp_name=None, + endp_name=None, # parameter explanation pending + wp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5921,9 +6228,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_create_client(self, - name=None, - password=None, - super_user=None, + name=None, # parameter explanation pending + password=None, # parameter explanation pending + super_user=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5951,8 +6258,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_diag(self, - arg1=None, - type=None, + arg1=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5979,9 +6286,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_discover(self, - disconnect=None, - resource=None, - shelf=None, + disconnect=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6009,8 +6316,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_do_pesq(self, - endp_name=None, - result_file_name=None, + endp_name=None, # parameter explanation pending + result_file_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6030,30 +6337,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#quit - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_exit(self, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_exit(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - } - response = self.json_post("/cli-json/exit", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -6061,10 +6344,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_file(self, - card=None, - cmd=None, - filename=None, - shelf=None, + card=None, # parameter explanation pending + cmd=None, # parameter explanation pending + filename=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6093,10 +6376,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_flash_attenuator(self, - filename=None, - resource=None, - serno=None, - shelf=None, + filename=None, # parameter explanation pending + resource=None, # parameter explanation pending + serno=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6125,8 +6408,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getavglatency(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6153,8 +6436,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxbps(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6181,8 +6464,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxrate(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6209,8 +6492,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getintxrate(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6237,8 +6520,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getipadd(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6265,8 +6548,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmac(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6293,8 +6576,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmask(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6321,8 +6604,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getpktdrops(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6349,8 +6632,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxendperrpkts(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6377,8 +6660,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxpkts(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6405,8 +6688,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxporterrpkts(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6433,8 +6716,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gettxpkts(self, - aorb=None, - cx=None, + aorb=None, # parameter explanation pending + cx=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6461,7 +6744,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gossip(self, - message=None, + message=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6487,7 +6770,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_help(self, - command=None, + command=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6513,10 +6796,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_init_wiser(self, - file_name=None, - node_count=None, - resource=None, - shelf=None, + file_name=None, # parameter explanation pending + node_count=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6545,8 +6828,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_licenses(self, - popup=None, - show_file=None, + popup=None, # parameter explanation pending + show_file=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6573,11 +6856,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_load(self, - action=None, - clean_chambers=None, - clean_dut=None, - clean_profiles=None, - name=None, + action=None, # parameter explanation pending + clean_chambers=None, # parameter explanation pending + clean_dut=None, # parameter explanation pending + clean_profiles=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6637,12 +6920,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - log_level_level.add_flags('bridge', 'dhcp') + log_level_level.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+log_level_level.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -6652,12 +6937,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - log_level_level.clear_flags('bridge', 'dhcp') + log_level_level.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+log_level_level.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -6668,14 +6955,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_log_level(self, - level=None, - target=None, + level=None, # parameter explanation pending + target=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6702,7 +6989,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_log_msg(self, - message=None, + message=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6728,8 +7015,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_login(self, - name=None, - password=None, + name=None, # parameter explanation pending + password=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6749,30 +7036,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#quit - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_logout(self, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_logout(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - } - response = self.json_post("/cli-json/logout", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -6804,9 +7067,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_cd(self, - collision_domain=None, - resource=None, - shelf=None, + collision_domain=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6834,9 +7097,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_channel_groups(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6864,8 +7127,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_endpoints(self, - endpoint=None, - extra=None, + endpoint=None, # parameter explanation pending + extra=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6892,7 +7155,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_pesq(self, - endpoint=None, + endpoint=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6938,12 +7201,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - nc_show_ports_probe_flags.add_flags('bridge', 'dhcp') + nc_show_ports_probe_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+nc_show_ports_probe_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -6953,12 +7218,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - nc_show_ports_probe_flags.clear_flags('bridge', 'dhcp') + nc_show_ports_probe_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+nc_show_ports_probe_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -6969,16 +7236,16 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_nc_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, # parameter explanation pending + probe_flags=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7007,9 +7274,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_ppp_links(self, - link_num=None, - resource=None, - shelf=None, + link_num=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7037,9 +7304,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_spans(self, - resource=None, - shelf=None, - span_number=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span_number=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7067,9 +7334,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vr(self, - resource=None, - router=None, - shelf=None, + resource=None, # parameter explanation pending + router=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7097,9 +7364,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vrcx(self, - cx_name=None, - resource=None, - shelf=None, + cx_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7127,15 +7394,15 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_notify_dhcp(self, - cmd=None, - netmask=None, - new_dns=None, - new_ip=None, - new_ip6=None, - new_mtu=None, - new_router=None, - port=None, - reason=None, + cmd=None, # parameter explanation pending + netmask=None, # parameter explanation pending + new_dns=None, # parameter explanation pending + new_ip=None, # parameter explanation pending + new_ip6=None, # parameter explanation pending + new_mtu=None, # parameter explanation pending + new_router=None, # parameter explanation pending + port=None, # parameter explanation pending + reason=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7169,9 +7436,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_port_reset_completed(self, - extra=None, - port=None, - type=None, + extra=None, # parameter explanation pending + port=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7199,10 +7466,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_port(self, - key=None, - port=None, - resource=None, - shelf=None, + key=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7231,8 +7498,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_ports(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7259,7 +7526,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_endp(self, - endp_name=None, + endp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7285,7 +7552,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_group(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7335,8 +7602,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reboot_os(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7363,11 +7630,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_report(self, - reporting_on=None, - rpt_dir=None, - save_endps=None, - save_ports=None, - save_resource=None, + reporting_on=None, # parameter explanation pending + rpt_dir=None, # parameter explanation pending + save_endps=None, # parameter explanation pending + save_ports=None, # parameter explanation pending + save_resource=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7399,7 +7666,7 @@ class LFJsonPost(LFCliBase): class reset_port_pre_ifdown(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - reset_port_pre_ifdown.clear_flags('bridge', 'dhcp') + reset_port_pre_ifdown.clear_flags(['bridge', 'dhcp']) print( 'value now: '+reset_port_pre_ifdown.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" P_IN = "P-IN" # Only call the portal login (do not reset drivers/supplicant/dhcp) @@ -7408,11 +7675,11 @@ class LFJsonPost(LFCliBase): def post_reset_port(self, - port=None, - pre_ifdown=None, - reset_ospf=None, - resource=None, - shelf=None, + port=None, # parameter explanation pending + pre_ifdown=None, # parameter explanation pending + reset_ospf=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7442,9 +7709,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reset_serial_span(self, - resource=None, - shelf=None, - span=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7472,9 +7739,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_attenuator(self, - resource=None, - serno=None, - shelf=None, + resource=None, # parameter explanation pending + serno=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7502,7 +7769,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd(self, - cd=None, + cd=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7528,8 +7795,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_endp(self, - cd=None, - endp=None, + cd=None, # parameter explanation pending + endp=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7556,8 +7823,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_vr(self, - cd=None, - endp=None, + cd=None, # parameter explanation pending + endp=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7584,7 +7851,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber(self, - chamber=None, + chamber=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7610,8 +7877,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber_path(self, - chamber=None, - path=None, + chamber=None, # parameter explanation pending + path=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7638,9 +7905,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_channel_group(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7668,8 +7935,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_client(self, - client_name=None, - client_password=None, + client_name=None, # parameter explanation pending + client_password=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7696,8 +7963,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cx(self, - cx_name=None, - test_mgr=None, + cx_name=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7724,7 +7991,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_db(self, - db_name=None, + db_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7750,7 +8017,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_dut(self, - shelf=None, + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7776,7 +8043,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_endp(self, - endp_name=None, + endp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7802,7 +8069,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_event(self, - event_id=None, + event_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7828,7 +8095,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_group(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7854,9 +8121,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + unit_num=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7884,7 +8151,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_profile(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7910,8 +8177,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_resource(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7938,8 +8205,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_rfgen(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7966,10 +8233,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7998,9 +8265,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_span(self, - resource=None, - shelf=None, - span_num=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span_num=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8028,7 +8295,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_test_mgr(self, - test_mgr=None, + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8054,8 +8321,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_text_blob(self, - name=None, - type=None, + name=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8082,8 +8349,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_tgcx(self, - cxname=None, - tgname=None, + cxname=None, # parameter explanation pending + tgname=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8110,8 +8377,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_threshold(self, - endp=None, - thresh_id=None, + endp=None, # parameter explanation pending + thresh_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8138,7 +8405,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_traffic_profile(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8164,9 +8431,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_venue(self, - resource=None, - shelf=None, - venu_id=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + venu_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8194,9 +8461,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vlan(self, - port=None, - resource=None, - shelf=None, + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8224,9 +8491,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vr(self, - resource=None, - router_name=None, - shelf=None, + resource=None, # parameter explanation pending + router_name=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8254,11 +8521,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vrcx(self, - connection_name=None, - resource=None, - shelf=None, - vr_id=None, - vrcx_only=None, + connection_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vr_id=None, # parameter explanation pending + vrcx_only=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8288,8 +8555,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_wanpath(self, - endp_name=None, - wp_name=None, + endp_name=None, # parameter explanation pending + wp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8316,13 +8583,13 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rpt_script(self, - endp=None, - flags=None, - group_action=None, - loop_count=None, - name=None, - private=None, - type=None, + endp=None, # parameter explanation pending + flags=None, # parameter explanation pending + group_action=None, # parameter explanation pending + loop_count=None, # parameter explanation pending + name=None, # parameter explanation pending + private=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8347,32 +8614,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#write - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_save(self, - db_name=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_save(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "db_name" : db_name, - } - response = self.json_post("/cli-json/save", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -8382,7 +8623,7 @@ class LFJsonPost(LFCliBase): class scan_wifi_extra(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - scan_wifi_extra.clear_flags('bridge', 'dhcp') + scan_wifi_extra.clear_flags(['bridge', 'dhcp']) print( 'value now: '+scan_wifi_extra.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NA = "NA" # (or left blank) the system does a full scan @@ -8391,11 +8632,11 @@ class LFJsonPost(LFCliBase): def post_scan_wifi(self, - extra=None, - key=None, - port=None, - resource=None, - shelf=None, + extra=None, # parameter explanation pending + key=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8444,12 +8685,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_arm_info_arm_flags.add_flags('bridge', 'dhcp') + set_arm_info_arm_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_arm_info_arm_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -8459,12 +8702,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_arm_info_arm_flags.clear_flags('bridge', 'dhcp') + set_arm_info_arm_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_arm_info_arm_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -8475,31 +8720,31 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_arm_info(self, - arm_flags=None, - burst=None, - dst_mac=None, - dst_mac_count=None, - ip_dst_max=None, - ip_dst_min=None, - ip_src_max=None, - ip_src_min=None, - max_pkt_size=None, - min_pkt_size=None, - multi_pkts=None, - name=None, - pkts_to_send=None, - src_mac=None, - src_mac_count=None, - udp_dst_max=None, - udp_dst_min=None, - udp_src_max=None, - udp_src_min=None, + arm_flags=None, # parameter explanation pending + burst=None, # parameter explanation pending + dst_mac=None, # parameter explanation pending + dst_mac_count=None, # parameter explanation pending + ip_dst_max=None, # parameter explanation pending + ip_dst_min=None, # parameter explanation pending + ip_src_max=None, # parameter explanation pending + ip_src_min=None, # parameter explanation pending + max_pkt_size=None, # parameter explanation pending + min_pkt_size=None, # parameter explanation pending + multi_pkts=None, # parameter explanation pending + name=None, # parameter explanation pending + pkts_to_send=None, # parameter explanation pending + src_mac=None, # parameter explanation pending + src_mac_count=None, # parameter explanation pending + udp_dst_max=None, # parameter explanation pending + udp_dst_min=None, # parameter explanation pending + udp_src_max=None, # parameter explanation pending + udp_src_min=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8543,16 +8788,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_attenuator(self, - atten_idx=None, - mode=None, - pulse_count=None, - pulse_interval_ms=None, - pulse_time_ms=None, - pulse_width_us5=None, - resource=None, - serno=None, - shelf=None, - val=None, + atten_idx=None, # parameter explanation pending + mode=None, # parameter explanation pending + pulse_count=None, # parameter explanation pending + pulse_interval_ms=None, # parameter explanation pending + pulse_time_ms=None, # parameter explanation pending + pulse_width_us5=None, # parameter explanation pending + resource=None, # parameter explanation pending + serno=None, # parameter explanation pending + shelf=None, # parameter explanation pending + val=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8587,12 +8832,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_chamber(self, - chamber=None, - cur_rotation=None, - position=None, - speed_rpm=None, - tilt=None, - turntable=None, + chamber=None, # parameter explanation pending + cur_rotation=None, # parameter explanation pending + position=None, # parameter explanation pending + speed_rpm=None, # parameter explanation pending + tilt=None, # parameter explanation pending + turntable=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8623,10 +8868,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_cx_report_timer(self, - cx_name=None, - cxonly=None, - milliseconds=None, - test_mgr=None, + cx_name=None, # parameter explanation pending + cxonly=None, # parameter explanation pending + milliseconds=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8657,7 +8902,7 @@ class LFJsonPost(LFCliBase): class set_cx_state_cx_state(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_cx_state_cx_state.clear_flags('bridge', 'dhcp') + set_cx_state_cx_state.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_cx_state_cx_state.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" DELETED = "DELETED" # Deletes the CX(s). @@ -8668,9 +8913,9 @@ class LFJsonPost(LFCliBase): def post_set_cx_state(self, - cx_name=None, - cx_state=None, - test_mgr=None, + cx_name=None, # parameter explanation pending + cx_state=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8698,11 +8943,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_addr(self, - ip=None, - mac=None, - max_port=None, - min_port=None, - name=None, + ip=None, # parameter explanation pending + mac=None, # parameter explanation pending + max_port=None, # parameter explanation pending + min_port=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8732,23 +8977,23 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_details(self, - conn_timeout=None, - dst_mac=None, - max_conn_timer=None, - max_ip_port=None, - max_reconn_pause=None, - mcast_src_ip=None, - mcast_src_port=None, - min_conn_timer=None, - min_reconn_pause=None, - name=None, - pkts_to_send=None, - rcvbuf_size=None, - sndbuf_size=None, - tcp_delack_segs=None, - tcp_max_delack=None, - tcp_min_delack=None, - tcp_mss=None, + conn_timeout=None, # parameter explanation pending + dst_mac=None, # parameter explanation pending + max_conn_timer=None, # parameter explanation pending + max_ip_port=None, # parameter explanation pending + max_reconn_pause=None, # parameter explanation pending + mcast_src_ip=None, # parameter explanation pending + mcast_src_port=None, # parameter explanation pending + min_conn_timer=None, # parameter explanation pending + min_reconn_pause=None, # parameter explanation pending + name=None, # parameter explanation pending + pkts_to_send=None, # parameter explanation pending + rcvbuf_size=None, # parameter explanation pending + sndbuf_size=None, # parameter explanation pending + tcp_delack_segs=None, # parameter explanation pending + tcp_max_delack=None, # parameter explanation pending + tcp_min_delack=None, # parameter explanation pending + tcp_mss=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8790,9 +9035,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_file(self, - file=None, - name=None, - playback=None, + file=None, # parameter explanation pending + name=None, # parameter explanation pending + playback=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8822,7 +9067,7 @@ class LFJsonPost(LFCliBase): class set_endp_flag_flag(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_endp_flag_flag.clear_flags('bridge', 'dhcp') + set_endp_flag_flag.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_endp_flag_flag.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" AutoHelper = "AutoHelper" # Automatically run on helper process @@ -8840,9 +9085,9 @@ class LFJsonPost(LFCliBase): def post_set_endp_flag(self, - flag=None, - name=None, - val=None, + flag=None, # parameter explanation pending + name=None, # parameter explanation pending + val=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8872,7 +9117,7 @@ class LFJsonPost(LFCliBase): class set_endp_payload_payload_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_endp_payload_payload_type.clear_flags('bridge', 'dhcp') + set_endp_payload_payload_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_endp_payload_payload_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" PRBS_11_8_10 = "PRBS_11_8_10" # PRBS (see above) @@ -8889,9 +9134,9 @@ class LFJsonPost(LFCliBase): def post_set_endp_payload(self, - name=None, - payload=None, - payload_type=None, + name=None, # parameter explanation pending + payload=None, # parameter explanation pending + payload_type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8919,11 +9164,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_pld_bounds(self, - is_random=None, - max_pld_size=None, - min_pld_size=None, - name=None, - use_checksum=None, + is_random=None, # parameter explanation pending + max_pld_size=None, # parameter explanation pending + min_pld_size=None, # parameter explanation pending + name=None, # parameter explanation pending + use_checksum=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8953,10 +9198,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_proxy(self, - enabled=None, - endp_name=None, - proxy_ip=None, - proxy_ip_port=None, + enabled=None, # parameter explanation pending + endp_name=None, # parameter explanation pending + proxy_ip=None, # parameter explanation pending + proxy_ip_port=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8985,8 +9230,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_quiesce(self, - name=None, - quiesce=None, + name=None, # parameter explanation pending + quiesce=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9013,8 +9258,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_report_timer(self, - endp_name=None, - milliseconds=None, + endp_name=None, # parameter explanation pending + milliseconds=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9043,7 +9288,7 @@ class LFJsonPost(LFCliBase): class set_endp_tos_tos(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_endp_tos_tos.clear_flags('bridge', 'dhcp') + set_endp_tos_tos.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_endp_tos_tos.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" LOWCOST = "LOWCOST" @@ -9053,9 +9298,9 @@ class LFJsonPost(LFCliBase): def post_set_endp_tos(self, - name=None, - priority=None, - tos=None, + name=None, # parameter explanation pending + priority=None, # parameter explanation pending + tos=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9083,10 +9328,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_tx_bounds(self, - is_bursty=None, - max_tx_rate=None, - min_tx_rate=None, - name=None, + is_bursty=None, # parameter explanation pending + max_tx_rate=None, # parameter explanation pending + min_tx_rate=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9130,12 +9375,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_ei_flags.add_flags('bridge', 'dhcp') + set_event_interest_ei_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_event_interest_ei_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9145,12 +9392,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_ei_flags.clear_flags('bridge', 'dhcp') + set_event_interest_ei_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_event_interest_ei_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9161,7 +9410,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -9211,12 +9460,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_events1.add_flags('bridge', 'dhcp') + set_event_interest_events1.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_event_interest_events1.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9226,12 +9477,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_events1.clear_flags('bridge', 'dhcp') + set_event_interest_events1.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_event_interest_events1.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9242,7 +9495,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -9277,12 +9530,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_events2.add_flags('bridge', 'dhcp') + set_event_interest_events2.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_event_interest_events2.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9292,12 +9547,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_interest_events2.clear_flags('bridge', 'dhcp') + set_event_interest_events2.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_event_interest_events2.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9308,19 +9565,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_event_interest(self, - ei_flags=None, - event_cnt=None, - events1=None, - events2=None, - events3=None, - events4=None, - var1=None, + ei_flags=None, # parameter explanation pending + event_cnt=None, # parameter explanation pending + events1=None, # parameter explanation pending + events2=None, # parameter explanation pending + events3=None, # parameter explanation pending + events4=None, # parameter explanation pending + var1=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9354,7 +9611,7 @@ class LFJsonPost(LFCliBase): class set_event_priority_event(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_priority_event.clear_flags('bridge', 'dhcp') + set_event_priority_event.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_event_priority_event.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Bad_MAC = 20 # Invalid MAC address configured. @@ -9383,7 +9640,7 @@ class LFJsonPost(LFCliBase): class set_event_priority_priority(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_event_priority_priority.clear_flags('bridge', 'dhcp') + set_event_priority_priority.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_event_priority_priority.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" AUTO = "AUTO" # Let event creator decide the priority. @@ -9395,8 +9652,8 @@ class LFJsonPost(LFCliBase): def post_set_event_priority(self, - event=None, - priority=None, + event=None, # parameter explanation pending + priority=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9423,16 +9680,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_fe_info(self, - directory=None, - io_direction=None, - max_file_size=None, - max_rw_sz=None, - min_file_size=None, - min_rw_sz=None, - name=None, - num_files=None, - prefix=None, - quiesce_after_files=None, + directory=None, # parameter explanation pending + io_direction=None, # parameter explanation pending + max_file_size=None, # parameter explanation pending + max_rw_sz=None, # parameter explanation pending + min_file_size=None, # parameter explanation pending + min_rw_sz=None, # parameter explanation pending + name=None, # parameter explanation pending + num_files=None, # parameter explanation pending + prefix=None, # parameter explanation pending + quiesce_after_files=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9469,7 +9726,7 @@ class LFJsonPost(LFCliBase): class set_flag_flag(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_flag_flag.clear_flags('bridge', 'dhcp') + set_flag_flag.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_flag_flag.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" brief = "brief" # Request more abbreviated output to various commands. @@ -9481,9 +9738,9 @@ class LFJsonPost(LFCliBase): def post_set_flag(self, - client=None, - flag=None, - val=None, + client=None, # parameter explanation pending + flag=None, # parameter explanation pending + val=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9511,8 +9768,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gen_cmd(self, - command=None, - name=None, + command=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9539,13 +9796,13 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gps_info(self, - altitude=None, - ew=None, - lattitude=None, - longitude=None, - ns=None, - resource=None, - shelf=None, + altitude=None, # parameter explanation pending + ew=None, # parameter explanation pending + lattitude=None, # parameter explanation pending + longitude=None, # parameter explanation pending + ns=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9577,11 +9834,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ifup_script(self, - flags=None, - port=None, - post_ifup_script=None, - resource=None, - shelf=None, + flags=None, # parameter explanation pending + port=None, # parameter explanation pending + post_ifup_script=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9611,7 +9868,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_license(self, - licenses=None, + licenses=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9637,11 +9894,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_mc_endp(self, - mcast_dest_port=None, - mcast_group=None, - name=None, - rcv_mcast=None, - ttl=None, + mcast_dest_port=None, # parameter explanation pending + mcast_group=None, # parameter explanation pending + name=None, # parameter explanation pending + rcv_mcast=None, # parameter explanation pending + ttl=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9671,9 +9928,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_password(self, - client=None, - new_password=None, - old_password=None, + client=None, # parameter explanation pending + new_password=None, # parameter explanation pending + old_password=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9701,7 +9958,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_poll_mode(self, - mode=None, + mode=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9752,12 +10009,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_cmd_flags.add_flags('bridge', 'dhcp') + set_port_cmd_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_port_cmd_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9767,12 +10026,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_cmd_flags.clear_flags('bridge', 'dhcp') + set_port_cmd_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_port_cmd_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9783,7 +10044,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -9836,12 +10097,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_current_flags.add_flags('bridge', 'dhcp') + set_port_current_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_port_current_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9851,12 +10114,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_current_flags.clear_flags('bridge', 'dhcp') + set_port_current_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_port_current_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9867,14 +10132,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class set_port_dhcp_client_id(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_dhcp_client_id.clear_flags('bridge', 'dhcp') + set_port_dhcp_client_id.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_port_dhcp_client_id.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NA = "NA" # Do not change from current value. @@ -9886,7 +10151,7 @@ class LFJsonPost(LFCliBase): class set_port_dhcp_hostname(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_dhcp_hostname.clear_flags('bridge', 'dhcp') + set_port_dhcp_hostname.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_port_dhcp_hostname.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NA = "NA" # Do not change from current value. @@ -9898,7 +10163,7 @@ class LFJsonPost(LFCliBase): class set_port_dhcp_vendor_id(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_dhcp_vendor_id.clear_flags('bridge', 'dhcp') + set_port_dhcp_vendor_id.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_port_dhcp_vendor_id.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NA = "NA" # Do not change from current value. @@ -9925,12 +10190,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_flags2.add_flags('bridge', 'dhcp') + set_port_flags2.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_port_flags2.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9940,12 +10207,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_flags2.clear_flags('bridge', 'dhcp') + set_port_flags2.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_port_flags2.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -9956,7 +10225,7 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value @@ -10007,12 +10276,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_interest.add_flags('bridge', 'dhcp') + set_port_interest.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_port_interest.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10022,12 +10293,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_port_interest.clear_flags('bridge', 'dhcp') + set_port_interest.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_port_interest.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10038,49 +10311,49 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_port(self, - alias=None, - br_aging_time=None, - br_forwarding_delay=None, - br_hello_time=None, - br_max_age=None, - br_port_cost=None, - br_port_priority=None, - br_priority=None, - bypass_wdt=None, - cmd_flags=None, - cpu_mask=None, - current_flags=None, - current_flags_msk=None, - dhcp_client_id=None, - dhcp_hostname=None, - dhcp_vendor_id=None, - dns_servers=None, - flags2=None, - gateway=None, - interest=None, - ip_addr=None, - ipsec_concentrator=None, - ipsec_local_id=None, - ipsec_passwd=None, - ipsec_remote_id=None, - ipv6_addr_global=None, - ipv6_addr_link=None, - ipv6_dflt_gw=None, - mac=None, - mtu=None, - netmask=None, - port=None, - report_timer=None, - resource=None, - shelf=None, - sta_br_id=None, - tx_queue_len=None, + alias=None, # parameter explanation pending + br_aging_time=None, # parameter explanation pending + br_forwarding_delay=None, # parameter explanation pending + br_hello_time=None, # parameter explanation pending + br_max_age=None, # parameter explanation pending + br_port_cost=None, # parameter explanation pending + br_port_priority=None, # parameter explanation pending + br_priority=None, # parameter explanation pending + bypass_wdt=None, # parameter explanation pending + cmd_flags=None, # parameter explanation pending + cpu_mask=None, # parameter explanation pending + current_flags=None, # parameter explanation pending + current_flags_msk=None, # parameter explanation pending + dhcp_client_id=None, # parameter explanation pending + dhcp_hostname=None, # parameter explanation pending + dhcp_vendor_id=None, # parameter explanation pending + dns_servers=None, # parameter explanation pending + flags2=None, # parameter explanation pending + gateway=None, # parameter explanation pending + interest=None, # parameter explanation pending + ip_addr=None, # parameter explanation pending + ipsec_concentrator=None, # parameter explanation pending + ipsec_local_id=None, # parameter explanation pending + ipsec_passwd=None, # parameter explanation pending + ipsec_remote_id=None, # parameter explanation pending + ipv6_addr_global=None, # parameter explanation pending + ipv6_addr_link=None, # parameter explanation pending + ipv6_dflt_gw=None, # parameter explanation pending + mac=None, # parameter explanation pending + mtu=None, # parameter explanation pending + netmask=None, # parameter explanation pending + port=None, # parameter explanation pending + report_timer=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + sta_br_id=None, # parameter explanation pending + tx_queue_len=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10142,11 +10415,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_port_alias(self, - alias=None, - port=None, - resource=None, - shelf=None, - vport=None, + alias=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vport=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10176,10 +10449,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ppp_link_state(self, - link=None, - ppp_state=None, - resource=None, - shelf=None, + link=None, # parameter explanation pending + ppp_state=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10210,24 +10483,24 @@ class LFJsonPost(LFCliBase): class set_resource_resource_flags(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_resource_resource_flags.clear_flags('bridge', 'dhcp') + set_resource_resource_flags.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_resource_resource_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" skip_load_db_on_start = 1 # Should we skip loading the DB on start? def post_set_resource(self, - device_profiles=None, - max_helper_count=None, - max_staged_bringup=None, - max_station_bringup=None, - max_trying_ifup=None, - resource=None, - resource_flags=None, - resource_flags_mask=None, - shelf=None, - top_left_x=None, - top_left_y=None, + device_profiles=None, # parameter explanation pending + max_helper_count=None, # parameter explanation pending + max_staged_bringup=None, # parameter explanation pending + max_station_bringup=None, # parameter explanation pending + max_trying_ifup=None, # parameter explanation pending + resource=None, # parameter explanation pending + resource_flags=None, # parameter explanation pending + resource_flags_mask=None, # parameter explanation pending + shelf=None, # parameter explanation pending + top_left_x=None, # parameter explanation pending + top_left_y=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10278,12 +10551,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_rfgen_rfgen_flags.add_flags('bridge', 'dhcp') + set_rfgen_rfgen_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_rfgen_rfgen_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10293,12 +10568,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_rfgen_rfgen_flags.clear_flags('bridge', 'dhcp') + set_rfgen_rfgen_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_rfgen_rfgen_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10309,25 +10586,25 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_rfgen(self, - bb_gain=None, - freq_khz=None, - gain=None, - id=None, - if_gain=None, - pulse_count=None, - pulse_interval_us=None, - pulse_width_us=None, - resource=None, - rfgen_flags=None, - rfgen_flags_mask=None, - shelf=None, - sweep_time_ms=None, + bb_gain=None, # parameter explanation pending + freq_khz=None, # parameter explanation pending + gain=None, # parameter explanation pending + id=None, # parameter explanation pending + if_gain=None, # parameter explanation pending + pulse_count=None, # parameter explanation pending + pulse_interval_us=None, # parameter explanation pending + pulse_width_us=None, # parameter explanation pending + resource=None, # parameter explanation pending + rfgen_flags=None, # parameter explanation pending + rfgen_flags_mask=None, # parameter explanation pending + shelf=None, # parameter explanation pending + sweep_time_ms=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10396,12 +10673,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_script_flags.add_flags('bridge', 'dhcp') + set_script_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_script_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10411,12 +10690,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_script_flags.clear_flags('bridge', 'dhcp') + set_script_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_script_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10427,14 +10708,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class set_script_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_script_type.clear_flags('bridge', 'dhcp') + set_script_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_script_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NONE = "NONE" # Delete any existing script. @@ -10445,13 +10726,13 @@ class LFJsonPost(LFCliBase): def post_set_script(self, - endp=None, - flags=None, - group_action=None, - loop_count=None, - name=None, - private=None, - type=None, + endp=None, # parameter explanation pending + flags=None, # parameter explanation pending + group_action=None, # parameter explanation pending + loop_count=None, # parameter explanation pending + name=None, # parameter explanation pending + private=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10483,10 +10764,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10515,24 +10796,24 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_voip_info(self, - codec=None, - first_call_delay=None, - jitter_buffer_sz=None, - local_sip_port=None, - loop_call_count=None, - loop_wavefile_count=None, - max_call_duration=None, - max_inter_call_gap=None, - messaging_protocol=None, - min_call_duration=None, - min_inter_call_gap=None, - name=None, - pesq_server_ip=None, - pesq_server_passwd=None, - pesq_server_port=None, - reg_expire_timer=None, - ringing_timer=None, - sound_dev=None, + codec=None, # parameter explanation pending + first_call_delay=None, # parameter explanation pending + jitter_buffer_sz=None, # parameter explanation pending + local_sip_port=None, # parameter explanation pending + loop_call_count=None, # parameter explanation pending + loop_wavefile_count=None, # parameter explanation pending + max_call_duration=None, # parameter explanation pending + max_inter_call_gap=None, # parameter explanation pending + messaging_protocol=None, # parameter explanation pending + min_call_duration=None, # parameter explanation pending + min_inter_call_gap=None, # parameter explanation pending + name=None, # parameter explanation pending + pesq_server_ip=None, # parameter explanation pending + pesq_server_passwd=None, # parameter explanation pending + pesq_server_port=None, # parameter explanation pending + reg_expire_timer=None, # parameter explanation pending + ringing_timer=None, # parameter explanation pending + sound_dev=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10575,15 +10856,15 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_vrcx_cost(self, - interface_cost=None, - local_dev=None, - local_dev_b=None, - remote_dev=None, - remote_dev_b=None, - resource=None, - shelf=None, - vr_name=None, - wanlink=None, + interface_cost=None, # parameter explanation pending + local_dev=None, # parameter explanation pending + local_dev_b=None, # parameter explanation pending + remote_dev=None, # parameter explanation pending + remote_dev_b=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + vr_name=None, # parameter explanation pending + wanlink=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10617,21 +10898,21 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanlink_info(self, - drop_freq=None, - dup_freq=None, - extra_buffer=None, - jitter_freq=None, - latency=None, - max_drop_amt=None, - max_jitter=None, - max_lateness=None, - max_reorder_amt=None, - min_drop_amt=None, - min_reorder_amt=None, - name=None, - playback_capture_file=None, - reorder_freq=None, - speed=None, + drop_freq=None, # parameter explanation pending + dup_freq=None, # parameter explanation pending + extra_buffer=None, # parameter explanation pending + jitter_freq=None, # parameter explanation pending + latency=None, # parameter explanation pending + max_drop_amt=None, # parameter explanation pending + max_jitter=None, # parameter explanation pending + max_lateness=None, # parameter explanation pending + max_reorder_amt=None, # parameter explanation pending + min_drop_amt=None, # parameter explanation pending + min_reorder_amt=None, # parameter explanation pending + name=None, # parameter explanation pending + playback_capture_file=None, # parameter explanation pending + reorder_freq=None, # parameter explanation pending + speed=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10671,9 +10952,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanlink_pcap(self, - capture=None, - directory=None, - name=None, + capture=None, # parameter explanation pending + directory=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10720,12 +11001,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wanpath_corruption_flags.add_flags('bridge', 'dhcp') + set_wanpath_corruption_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_wanpath_corruption_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10735,12 +11018,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wanpath_corruption_flags.clear_flags('bridge', 'dhcp') + set_wanpath_corruption_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_wanpath_corruption_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10751,20 +11036,20 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_wanpath_corruption(self, - byte=None, - flags=None, - index=None, - max_offset=None, - min_offset=None, - name=None, - path=None, - rate=None, + byte=None, # parameter explanation pending + flags=None, # parameter explanation pending + index=None, # parameter explanation pending + max_offset=None, # parameter explanation pending + min_offset=None, # parameter explanation pending + name=None, # parameter explanation pending + path=None, # parameter explanation pending + rate=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10797,14 +11082,14 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanpath_filter(self, - defer_flush=None, - dst_filter=None, - filter_type=None, - passive=None, - reverse=None, - src_filter=None, - wl_name=None, - wp_name=None, + defer_flush=None, # parameter explanation pending + dst_filter=None, # parameter explanation pending + filter_type=None, # parameter explanation pending + passive=None, # parameter explanation pending + reverse=None, # parameter explanation pending + src_filter=None, # parameter explanation pending + wl_name=None, # parameter explanation pending + wp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10839,7 +11124,7 @@ class LFJsonPost(LFCliBase): class set_wanpath_running_running(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wanpath_running_running.clear_flags('bridge', 'dhcp') + set_wanpath_running_running.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_wanpath_running_running.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" AS_PARENT = "AS_PARENT" # then it will be started and stopped as the parent WanLink is. @@ -10848,9 +11133,9 @@ class LFJsonPost(LFCliBase): def post_set_wanpath_running(self, - running=None, - wl_name=None, - wp_name=None, + running=None, # parameter explanation pending + wl_name=None, # parameter explanation pending + wp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10905,12 +11190,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wifi_corruptions_corrupt_flags.add_flags('bridge', 'dhcp') + set_wifi_corruptions_corrupt_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_wifi_corruptions_corrupt_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10920,12 +11207,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wifi_corruptions_corrupt_flags.clear_flags('bridge', 'dhcp') + set_wifi_corruptions_corrupt_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_wifi_corruptions_corrupt_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -10936,25 +11225,25 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_wifi_corruptions(self, - corrupt_flags=None, - corrupt_per_mil=None, - delay_flags=None, - delay_max=None, - delay_min=None, - dup_flags=None, - dup_per_65535=None, - ignore_flags=None, - ignore_per_mil=None, - port=None, - req_flush=None, - resource=None, - shelf=None, + corrupt_flags=None, # parameter explanation pending + corrupt_per_mil=None, # parameter explanation pending + delay_flags=None, # parameter explanation pending + delay_max=None, # parameter explanation pending + delay_min=None, # parameter explanation pending + dup_flags=None, # parameter explanation pending + dup_per_65535=None, # parameter explanation pending + ignore_flags=None, # parameter explanation pending + ignore_per_mil=None, # parameter explanation pending + port=None, # parameter explanation pending + req_flush=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10992,11 +11281,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_custom(self, - port=None, - resource=None, - shelf=None, - text=None, - type=None, + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + text=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11026,38 +11315,38 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_extra(self, - anonymous_identity=None, - anqp_3gpp_cell_net=None, - ca_cert=None, - client_cert=None, - domain=None, - eap=None, - group=None, - hessid=None, - identity=None, - imsi=None, - ipaddr_type_avail=None, - key=None, - key_mgmt=None, - milenage=None, - network_auth_type=None, - network_type=None, - pac_file=None, - pairwise=None, - password=None, - phase1=None, - phase2=None, - pin=None, - pk_passwd=None, - port=None, - private_key=None, - psk=None, - realm=None, - resource=None, - roaming_consortium=None, - shelf=None, - venue_group=None, - venue_type=None, + anonymous_identity=None, # parameter explanation pending + anqp_3gpp_cell_net=None, # parameter explanation pending + ca_cert=None, # parameter explanation pending + client_cert=None, # parameter explanation pending + domain=None, # parameter explanation pending + eap=None, # parameter explanation pending + group=None, # parameter explanation pending + hessid=None, # parameter explanation pending + identity=None, # parameter explanation pending + imsi=None, # parameter explanation pending + ipaddr_type_avail=None, # parameter explanation pending + key=None, # parameter explanation pending + key_mgmt=None, # parameter explanation pending + milenage=None, # parameter explanation pending + network_auth_type=None, # parameter explanation pending + network_type=None, # parameter explanation pending + pac_file=None, # parameter explanation pending + pairwise=None, # parameter explanation pending + password=None, # parameter explanation pending + phase1=None, # parameter explanation pending + phase2=None, # parameter explanation pending + pin=None, # parameter explanation pending + pk_passwd=None, # parameter explanation pending + port=None, # parameter explanation pending + private_key=None, # parameter explanation pending + psk=None, # parameter explanation pending + realm=None, # parameter explanation pending + resource=None, # parameter explanation pending + roaming_consortium=None, # parameter explanation pending + shelf=None, # parameter explanation pending + venue_group=None, # parameter explanation pending + venue_type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11114,22 +11403,22 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_extra2(self, - corrupt_gtk_rekey_mic=None, - freq_24=None, - freq_5=None, - ignore_assoc=None, - ignore_auth=None, - ignore_probe=None, - ignore_reassoc=None, - ocsp=None, - port=None, - post_ifup_script=None, - radius_ip=None, - radius_port=None, - req_flush=None, - resource=None, - shelf=None, - venue_id=None, + corrupt_gtk_rekey_mic=None, # parameter explanation pending + freq_24=None, # parameter explanation pending + freq_5=None, # parameter explanation pending + ignore_assoc=None, # parameter explanation pending + ignore_auth=None, # parameter explanation pending + ignore_probe=None, # parameter explanation pending + ignore_reassoc=None, # parameter explanation pending + ocsp=None, # parameter explanation pending + port=None, # parameter explanation pending + post_ifup_script=None, # parameter explanation pending + radius_ip=None, # parameter explanation pending + radius_port=None, # parameter explanation pending + req_flush=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + venue_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11191,12 +11480,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wifi_radio_flags.add_flags('bridge', 'dhcp') + set_wifi_radio_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_wifi_radio_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -11206,12 +11497,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wifi_radio_flags.clear_flags('bridge', 'dhcp') + set_wifi_radio_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_wifi_radio_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -11222,18 +11515,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value class set_wifi_radio_mode(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wifi_radio_mode.clear_flags('bridge', 'dhcp') + set_wifi_radio_mode.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_wifi_radio_mode.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_802_11a = 1 # 802.11a AUTO = 0 # 802.11g + aAX = 15 # 802.11a-AX (6E disables /n and /ac) abg = 4 # 802.11abg abgn = 5 # 802.11abgn abgnAC = 8 # 802.11abgn-AC @@ -11250,39 +11544,39 @@ class LFJsonPost(LFCliBase): def post_set_wifi_radio(self, - active_peer_count=None, - ampdu_factor=None, - antenna=None, - channel=None, - const_tx=None, - country=None, - flags=None, - flags_mask=None, - frag_thresh=None, - frequency=None, - fwname=None, - fwver=None, - mac=None, - max_amsdu=None, - mode=None, - peer_count=None, - pref_ap=None, - pulse2_interval_us=None, - pulse_interval=None, - pulse_width=None, - radio=None, - rate=None, - rate_ctrl_count=None, - resource=None, - rts=None, - shelf=None, - skid_limit=None, - stations_count=None, - tids_count=None, - tx_pulses=None, - txdesc_count=None, - txpower=None, - vdev_count=None, + active_peer_count=None, # parameter explanation pending + ampdu_factor=None, # parameter explanation pending + antenna=None, # parameter explanation pending + channel=None, # parameter explanation pending + const_tx=None, # parameter explanation pending + country=None, # parameter explanation pending + flags=None, # parameter explanation pending + flags_mask=None, # parameter explanation pending + frag_thresh=None, # parameter explanation pending + frequency=None, # parameter explanation pending + fwname=None, # parameter explanation pending + fwver=None, # parameter explanation pending + mac=None, # parameter explanation pending + max_amsdu=None, # parameter explanation pending + mode=None, # parameter explanation pending + peer_count=None, # parameter explanation pending + pref_ap=None, # parameter explanation pending + pulse2_interval_us=None, # parameter explanation pending + pulse_interval=None, # parameter explanation pending + pulse_width=None, # parameter explanation pending + radio=None, # parameter explanation pending + rate=None, # parameter explanation pending + rate_ctrl_count=None, # parameter explanation pending + resource=None, # parameter explanation pending + rts=None, # parameter explanation pending + shelf=None, # parameter explanation pending + skid_limit=None, # parameter explanation pending + stations_count=None, # parameter explanation pending + tids_count=None, # parameter explanation pending + tx_pulses=None, # parameter explanation pending + txdesc_count=None, # parameter explanation pending + txpower=None, # parameter explanation pending + vdev_count=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11340,17 +11634,17 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_txo(self, - port=None, - resource=None, - shelf=None, - txo_bw=None, - txo_enable=None, - txo_mcs=None, - txo_nss=None, - txo_pream=None, - txo_retries=None, - txo_sgi=None, - txo_txpower=None, + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + txo_bw=None, # parameter explanation pending + txo_enable=None, # parameter explanation pending + txo_mcs=None, # parameter explanation pending + txo_nss=None, # parameter explanation pending + txo_pream=None, # parameter explanation pending + txo_retries=None, # parameter explanation pending + txo_sgi=None, # parameter explanation pending + txo_txpower=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11405,12 +11699,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wl_corruption_flags.add_flags('bridge', 'dhcp') + set_wl_corruption_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+set_wl_corruption_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -11420,12 +11716,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wl_corruption_flags.clear_flags('bridge', 'dhcp') + set_wl_corruption_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+set_wl_corruption_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -11436,19 +11734,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_set_wl_corruption(self, - byte=None, - flags=None, - index=None, - max_offset=None, - min_offset=None, - name=None, - rate=None, + byte=None, # parameter explanation pending + flags=None, # parameter explanation pending + index=None, # parameter explanation pending + max_offset=None, # parameter explanation pending + min_offset=None, # parameter explanation pending + name=None, # parameter explanation pending + rate=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11482,7 +11780,7 @@ class LFJsonPost(LFCliBase): class set_wl_qdisc_qdisc(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - set_wl_qdisc_qdisc.clear_flags('bridge', 'dhcp') + set_wl_qdisc_qdisc.clear_flags(['bridge', 'dhcp']) print( 'value now: '+set_wl_qdisc_qdisc.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" FIFO = "FIFO" # is the default queuing discipline, no arguments @@ -11490,8 +11788,8 @@ class LFJsonPost(LFCliBase): def post_set_wl_qdisc(self, - name=None, - qdisc=None, + name=None, # parameter explanation pending + qdisc=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11511,183 +11809,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#set_wanpath_corruption - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - class set_wanpath_corruption_flags(IntFlag): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - selected_named_flag_map = {} - temp_flag_value = 0x0 - - BIT_FLIP = 0x4 # Flip a random bit in a byte. - BIT_TRANSPOSE = 0x8 # Transpose two side-by-side bits in a byte. - DO_CHAIN_ON_HIT = 0x10 # Do next corruption if this corruption is applied. - OVERWRITE_FIXED = 0x2 # Write a fixed value to a byte. - OVERWRITE_RANDOM = 0x1 # Write a random value to a byte. - RECALC_CSUMS = 0x20 # Attempt to re-calculate UDP and TCP checksums. - - # (internal method) call this from add_flags() or remove_flags() - def update_flag_value(self): - self.temp_flag_value = 0x0 - for flag in self.selected_named_flag_map.keys(): - self.temp_flag_value |= flag.value - - def add_flags(self, flag_names=[]): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - set_wanpath_corruption_flags.add_flags('bridge', 'dhcp') - print('value now: '+set_wanpath_corruption_flags.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - if type(flag_names) is list: - for flag in (flag_names): - if flag is None: - continue - self.selected_named_flag_map.put(flag, 0) - elif flag_names is not None: - self.selected_named_flag_map.put(flag_names, 0) - self.update_flag_value() - - def clear_flags(self, flag_names=[]): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - set_wanpath_corruption_flags.clear_flags('bridge', 'dhcp') - print( 'value now: '+set_wanpath_corruption_flags.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - if type(flag_names) is list: - for flag in (flag_names): - if flag is None: - continue - if self.selected_named_flag_map.contains(flag): - self.selected_named_flag_map.remove(flag) - elif (flag_names is not None) and self.selected_named_flag_map.contains(flag_names): - self.selected_named_flag_map.remove(flag_names) - self.update_flag_value() - - def value(self, flag_names=[]): - return self.temp_flag_value - - - - def post_set_wp_corruption(self, - byte=None, - flags=None, - index=None, - max_offset=None, - min_offset=None, - name=None, - path=None, - rate=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_set_wp_corruption(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "byte" : byte, - "flags" : flags, - "index" : index, - "max_offset" : max_offset, - "min_offset" : min_offset, - "name" : name, - "path" : path, - "rate" : rate, - } - response = self.json_post("/cli-json/set_wp_corruption", - data, - debug_=debug_) - return response - # - - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#set_wanpath_filter - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_set_wp_filter(self, - defer_flush=None, - dst_filter=None, - filter_type=None, - passive=None, - reverse=None, - src_filter=None, - wl_name=None, - wp_name=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_set_wp_filter(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "defer_flush" : defer_flush, - "dst_filter" : dst_filter, - "filter_type" : filter_type, - "passive" : passive, - "reverse" : reverse, - "src_filter" : src_filter, - "wl_name" : wl_name, - "wp_name" : wp_name, - } - response = self.json_post("/cli-json/set_wp_filter", - data, - debug_=debug_) - return response - # - - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#set_wanpath_running - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - class set_wanpath_running_running(Enum): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - set_wanpath_running_running.clear_flags('bridge', 'dhcp') - print( 'value now: '+set_wanpath_running_running.value()) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - AS_PARENT = "AS_PARENT" # then it will be started and stopped as the parent WanLink is. - RUNNING = "RUNNING" # then it will be running at all times - STOPPED = "STOPPED" # then it will not be running at any time. - - - def post_set_wp_running(self, - running=None, - wl_name=None, - wp_name=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_set_wp_running(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "running" : running, - "wl_name" : wl_name, - "wp_name" : wp_name, - } - response = self.json_post("/cli-json/set_wp_running", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -11697,7 +11818,7 @@ class LFJsonPost(LFCliBase): class show_alerts_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - show_alerts_type.clear_flags('bridge', 'dhcp') + show_alerts_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+show_alerts_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" All = "All" @@ -11715,12 +11836,12 @@ class LFJsonPost(LFCliBase): def post_show_alerts(self, - card=None, - endp=None, - extra=None, - port=None, - shelf=None, - type=None, + card=None, # parameter explanation pending + endp=None, # parameter explanation pending + extra=None, # parameter explanation pending + port=None, # parameter explanation pending + shelf=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11751,9 +11872,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_attenuators(self, - resource=None, - serno=None, - shelf=None, + resource=None, # parameter explanation pending + serno=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11774,34 +11895,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#show_resources - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_show_cards(self, - resource=None, - shelf=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_show_cards(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "resource" : resource, - "shelf" : shelf, - } - response = self.json_post("/cli-json/show_cards", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -11809,9 +11902,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cd(self, - collision_domain=None, - resource=None, - shelf=None, + collision_domain=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11839,7 +11932,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_chamber(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11865,9 +11958,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_channel_groups(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11919,8 +12012,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cx(self, - cross_connect=None, - test_mgr=None, + cross_connect=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11947,8 +12040,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cxe(self, - cross_connect=None, - test_mgr=None, + cross_connect=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11999,7 +12092,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_dut(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12025,8 +12118,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endp_payload(self, - max_bytes=None, - name=None, + max_bytes=None, # parameter explanation pending + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12053,8 +12146,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endpoints(self, - endpoint=None, - extra=None, + endpoint=None, # parameter explanation pending + extra=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12081,7 +12174,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_err(self, - message=None, + message=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12133,7 +12226,7 @@ class LFJsonPost(LFCliBase): class show_events_type(Enum): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - show_events_type.clear_flags('bridge', 'dhcp') + show_events_type.clear_flags(['bridge', 'dhcp']) print( 'value now: '+show_events_type.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" All = "All" @@ -12151,12 +12244,12 @@ class LFJsonPost(LFCliBase): def post_show_events(self, - card=None, - endp=None, - extra=None, - port=None, - shelf=None, - type=None, + card=None, # parameter explanation pending + endp=None, # parameter explanation pending + extra=None, # parameter explanation pending + port=None, # parameter explanation pending + shelf=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12187,12 +12280,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_files(self, - dir_flags=None, - directory=None, - filter=None, - key=None, - resource=None, - shelf=None, + dir_flags=None, # parameter explanation pending + directory=None, # parameter explanation pending + filter=None, # parameter explanation pending + key=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12223,7 +12316,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_group(self, - group=None, + group=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12249,7 +12342,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_pesq(self, - endpoint=None, + endpoint=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12275,10 +12368,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, # parameter explanation pending + probe_flags=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12307,9 +12400,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ppp_links(self, - link_num=None, - resource=None, - shelf=None, + link_num=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12337,7 +12430,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_profile(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12363,8 +12456,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_resources(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12391,8 +12484,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rfgen(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12419,10 +12512,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rt(self, - key=None, - resource=None, - shelf=None, - virtual_router=None, + key=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + virtual_router=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12451,8 +12544,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_script_results(self, - endpoint=None, - key=None, + endpoint=None, # parameter explanation pending + key=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12479,9 +12572,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_spans(self, - resource=None, - shelf=None, - span_number=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + span_number=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12509,9 +12602,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_text_blob(self, - brief=None, - name=None, - type=None, + brief=None, # parameter explanation pending + name=None, # parameter explanation pending + type=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12539,7 +12632,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_tm(self, - test_mgr=None, + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12565,7 +12658,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_traffic_profile(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12591,9 +12684,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_venue(self, - resource=None, - shelf=None, - venu_id=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + venu_id=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12621,9 +12714,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vr(self, - resource=None, - router=None, - shelf=None, + resource=None, # parameter explanation pending + router=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12651,9 +12744,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vrcx(self, - cx_name=None, - resource=None, - shelf=None, + cx_name=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12681,8 +12774,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_wanpaths(self, - endpoint=None, - wanpath=None, + endpoint=None, # parameter explanation pending + wanpath=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12702,34 +12795,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#show_wanpaths - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_show_wps(self, - endpoint=None, - wanpath=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_show_wps(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "endpoint" : endpoint, - "wanpath" : wanpath, - } - response = self.json_post("/cli-json/show_wps", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -12737,9 +12802,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown(self, - chdir=None, - really=None, - serverctl=None, + chdir=None, # parameter explanation pending + really=None, # parameter explanation pending + serverctl=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12760,34 +12825,6 @@ class LFJsonPost(LFCliBase): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Notes for type requests - - https://www.candelatech.com/lfcli_ug.php#shutdown_resource - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - - def post_shutdown_card(self, - resource=None, - shelf=None, - debug_=False): - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Example Usage: - result = post_shutdown_card(param=value ...) - pprint.pprint( result ) - ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - debug_ |= self.debug - data = { - "resource" : resource, - "shelf" : shelf, - } - response = self.json_post("/cli-json/shutdown_card", - data, - debug_=debug_) - return response - # - - - """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Notes for type requests @@ -12795,8 +12832,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_os(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12823,8 +12860,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_resource(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12868,12 +12905,14 @@ class LFJsonPost(LFCliBase): for flag in self.selected_named_flag_map.keys(): self.temp_flag_value |= flag.value - def add_flags(self, flag_names=[]): + def add_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - sniff_port_flags.add_flags('bridge', 'dhcp') + sniff_port_flags.add_flags(flag_names=['bridge', 'dhcp']) print('value now: '+sniff_port_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -12883,12 +12922,14 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.put(flag_names, 0) self.update_flag_value() - def clear_flags(self, flag_names=[]): + def clear_flags(self, flag_names=None): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: - sniff_port_flags.clear_flags('bridge', 'dhcp') + sniff_port_flags.clear_flags(flag_names=['bridge', 'dhcp']) print( 'value now: '+sniff_port_flags.value()) ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" + if not flag_names: + raise ValueError("flag_names should be a name or a list of names, not None") if type(flag_names) is list: for flag in (flag_names): if flag is None: @@ -12899,19 +12940,19 @@ class LFJsonPost(LFCliBase): self.selected_named_flag_map.remove(flag_names) self.update_flag_value() - def value(self, flag_names=[]): + def value(self): return self.temp_flag_value def post_sniff_port(self, - display=None, - duration=None, - flags=None, - outfile=None, - port=None, - resource=None, - shelf=None, + display=None, # parameter explanation pending + duration=None, # parameter explanation pending + flags=None, # parameter explanation pending + outfile=None, # parameter explanation pending + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12943,7 +12984,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_endp(self, - endp_name=None, + endp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12969,7 +13010,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_group(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12995,9 +13036,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + unit_num=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13025,7 +13066,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_endp(self, - endp_name=None, + endp_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13051,7 +13092,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_group(self, - name=None, + name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13077,9 +13118,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + unit_num=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13107,11 +13148,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tail(self, - cmd=None, - key=None, - message=None, - resource=None, - shelf=None, + cmd=None, # parameter explanation pending + key=None, # parameter explanation pending + message=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13141,8 +13182,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_register(self, - client_name=None, - test_mgr=None, + client_name=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13169,8 +13210,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_unregister(self, - client_name=None, - test_mgr=None, + client_name=None, # parameter explanation pending + test_mgr=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13245,10 +13286,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_cli_cmd(self, - port=None, - resource=None, - shelf=None, - wpa_cli_cmd=None, + port=None, # parameter explanation pending + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending + wpa_cli_cmd=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13277,10 +13318,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_event(self, - device=None, - event=None, - msg=None, - status=None, + device=None, # parameter explanation pending + event=None, # parameter explanation pending + msg=None, # parameter explanation pending + status=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13309,8 +13350,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wiser_reset(self, - resource=None, - shelf=None, + resource=None, # parameter explanation pending + shelf=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13337,7 +13378,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_write(self, - db_name=None, + db_name=None, # parameter explanation pending debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: