diff --git a/py-json/LANforge/lf_json_autogen.py b/py-json/LANforge/lf_json_autogen.py index ba9795ee..524f5965 100644 --- a/py-json/LANforge/lf_json_autogen.py +++ b/py-json/LANforge/lf_json_autogen.py @@ -1,12 +1,11 @@ #!/usr/bin/env python3 """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated by LANforge JsonApiPythonGenerator, Tue Jun 22 15:59:34 PDT 2021 + Generated by LANforge JsonApiPythonGenerator, Wed Jun 30 13:53:58 PDT 2021 This file expects to live in py-json/LANforge directory. ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" -import sys -import json import keyword from enum import Enum +from enum import IntFlag # from LANforge import LFRequest # from LANforge.lfcli_base import LFCliBase from lfcli_base import LFCliBase @@ -47,39 +46,58 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /attenuator + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - entity+id entity id - module+1 module 1 - module+2 module 2 - module+3 module 3 - module+4 module 4 - module+5 module 5 - module+6 module 6 - module+7 module 7 - module+8 module 8 - name name - script script - state state - temperature temperature + ...examples how to call method(s) here... + Request one of these URLs: + /attenuator/ + /attenuator/$shelf_id + /attenuator/$shelf_id/$resource_id + /attenuator/$shelf_id/$resource_id/$port_id + /attenuators/ + /attenuators/$shelf_id + /attenuators/$shelf_id/$resource_id + /attenuators/$shelf_id/$resource_id/$port_id + + When requesting specific column names, they need to be URL Encoded. + entity+id, module+1, module+2, module+3, module+4, module+5, module+6, module+7, + module+8, name, script, state, temperature + Example URL: /attenuator?fields=entity+id,module+1 + + The data returned is going to look like: + { + 'entity id': X + 'module 1': X + 'module 2': X + 'module 3': X + 'module 4': X + 'module 5': X + 'module 6': X + 'module 7': X + 'module 8': X + 'name': X + 'script': X + 'state': X + 'temperature': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_attenuator(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/attenuator" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -91,48 +109,63 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /chamber + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - chamber chamber - chamber+connections chamber connections - chamber+resources chamber resources - chamber+type chamber type - duts duts - entity+id entity id - flags flags - hide hide - isolation isolation - marked marked - open open - reported+rotation+%28deg%29 reported rotation (deg) - reported+rpm reported rpm - reported+tilt+%28deg%29 reported tilt (deg) - resource resource - rotation+%28deg%29 rotation (deg) - rpm rpm - smas smas - tilt+%28deg%29 tilt (deg) - turntable turntable - turntable+type turntable type - virtual virtual + ...examples how to call method(s) here... + Request one of these URLs: + /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, + flags, hide, isolation, marked, open, reported+rotation+%28deg%29, reported+rpm, + reported+tilt+%28deg%29, resource, rotation+%28deg%29, rpm, smas, tilt+%28deg%29, turntable, + turntable+type, virtual + Example URL: /chamber?fields=chamber,chamber+connections + + The data returned is going to look like: + { + 'chamber': X + 'chamber connections': X + 'chamber resources': X + 'chamber type': X + 'duts': X + 'entity id': X + 'flags': X + 'hide': X + 'isolation': X + 'marked': X + 'open': X + 'reported rotation (deg)': X + 'reported rpm ': X + 'reported tilt (deg)': X + 'resource': X + 'rotation (deg)': X + 'rpm': X + 'smas': X + 'tilt (deg)': X + 'turntable': X + 'turntable type': X + 'virtual': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_chamber(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/chamber" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -144,42 +177,56 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cx + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - avg+rtt avg rtt - bps+rx+a bps rx a - bps+rx+b bps rx b - drop+pkts+a drop pkts a - drop+pkts+b drop pkts b - eid eid - endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29 endpoints (a ↔ b) - entity+id entity id - name name - pkt+rx+a pkt rx a - pkt+rx+b pkt rx b - rpt+timer rpt timer - rx+drop+%25+a rx drop % a - rx+drop+%25+b rx drop % b - state state - type type + ...examples how to call method(s) here... + Request one of these URLs: + /cx/ + /cx/$cx_id + + When requesting specific column names, they need to be URL Encoded. + avg+rtt, bps+rx+a, bps+rx+b, drop+pkts+a, drop+pkts+b, eid, endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29, + entity+id, name, pkt+rx+a, pkt+rx+b, rpt+timer, rx+drop+%25+a, rx+drop+%25+b, + state, type + Example URL: /cx?fields=avg+rtt,bps+rx+a + + The data returned is going to look like: + { + 'avg rtt': X + 'bps rx a': X + 'bps rx b': X + 'drop pkts a': X + 'drop pkts b': X + 'eid': X + 'endpoints (a ↔ b)': X + 'entity id': X + 'name': X + 'pkt rx a': X + 'pkt rx b': X + 'rpt timer': X + 'rx drop % a': X + 'rx drop % b': X + 'state': X + 'type': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_cx(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/cx" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -191,67 +238,84 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /dut + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - api+version api version - bssid-1 bssid-1 - bssid-2 bssid-2 - bssid-3 bssid-3 - bssid-4 bssid-4 - bssid-5 bssid-5 - bssid-6 bssid-6 - bssid-7 bssid-7 - bssid-8 bssid-8 - dut dut - eap-id eap-id - entity+id entity id - hw+info hw info - image+file image file - lan lan - mgt+ip mgt ip - model+number model number - notes notes - num+ant+radio+1 num ant radio 1 - num+ant+radio+2 num ant radio 2 - num+ant+radio+3 num ant radio 3 - password-1 password-1 - password-2 password-2 - password-3 password-3 - password-4 password-4 - password-5 password-5 - password-6 password-6 - password-7 password-7 - password-8 password-8 - serial+number serial number - serial+port serial port - ssid-1 ssid-1 - ssid-2 ssid-2 - ssid-3 ssid-3 - ssid-4 ssid-4 - ssid-5 ssid-5 - ssid-6 ssid-6 - ssid-7 ssid-7 - ssid-8 ssid-8 - sw+info sw info - wan wan + ...examples how to call method(s) here... + Request one of these URLs: + /dut/ + /dut/$name + + When requesting specific column names, they need to be URL Encoded. + api+version, bssid-1, bssid-2, bssid-3, bssid-4, bssid-5, bssid-6, bssid-7, + bssid-8, dut, eap-id, entity+id, hw+info, image+file, lan, mgt+ip, model+number, + notes, num+ant+radio+1, num+ant+radio+2, num+ant+radio+3, password-1, password-2, + password-3, password-4, password-5, password-6, password-7, password-8, serial+number, + serial+port, ssid-1, ssid-2, ssid-3, ssid-4, ssid-5, ssid-6, ssid-7, ssid-8, + sw+info, wan + Example URL: /dut?fields=api+version,bssid-1 + + The data returned is going to look like: + { + 'api version': X + 'bssid-1': X + 'bssid-2': X + 'bssid-3': X + 'bssid-4': X + 'bssid-5': X + 'bssid-6': X + 'bssid-7': X + 'bssid-8': X + 'dut': X + 'eap-id': X + 'entity id': X + 'hw info': X + 'image file': X + 'lan': X + 'mgt ip': X + 'model number': X + 'notes': X + 'num ant radio 1': X + 'num ant radio 2': X + 'num ant radio 3': X + 'password-1': X + 'password-2': X + 'password-3': X + 'password-4': X + 'password-5': X + 'password-6': X + 'password-7': X + 'password-8': X + 'serial number': X + 'serial port': X + 'ssid-1': X + 'ssid-2': X + 'ssid-3': X + 'ssid-4': X + 'ssid-5': X + 'ssid-6': X + 'ssid-7': X + 'ssid-8': X + 'sw info': X + 'wan': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_dut(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/dut" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -263,82 +327,101 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /endp + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - 1st+rx 1st rx - a%2Fb a/b - bursty bursty - crc+fail crc fail - cwnd cwnd - cx+active cx active - cx+estab cx estab - cx+estab%2Fs cx estab/s - cx+to cx to - delay delay - destination+addr destination addr - dropped dropped - dup+pkts dup pkts - eid eid - elapsed elapsed - entity+id entity id - jitter jitter - max+pdu max pdu - max+rate max rate - min+pdu min pdu - min+rate min rate - mng mng - name name - ooo+pkts ooo pkts - pattern pattern - pdu%2Fs+rx pdu/s rx - pdu%2Fs+tx pdu/s tx - pps+rx+ll pps rx ll - pps+tx+ll pps tx ll - rcv+buf rcv buf - replays replays - run run - rx+ber rx ber - rx+bytes rx bytes - rx+drop+%25 rx drop % - rx+dup+%25 rx dup % - rx+ooo+%25 rx ooo % - rx+pdus rx pdus - rx+pkts+ll rx pkts ll - rx+rate rx rate - rx+rate+%281%C2%A0min%29 rx rate (1 min) - rx+rate+%28last%29 rx rate (last) - rx+rate+ll rx rate ll - rx+wrong+dev rx wrong dev - script script - send+buf send buf - source+addr source addr - tcp+mss tcp mss - tcp+rtx tcp rtx - tx+bytes tx bytes - tx+pdus tx pdus - tx+pkts+ll tx pkts ll - tx+rate tx rate - tx+rate+%281%C2%A0min%29 tx rate (1 min) - tx+rate+%28last%29 tx rate (last) - tx+rate+ll tx rate ll + ...examples how to call method(s) here... + Request one of these URLs: + /endp/ + /endp/$endp_id + + When requesting specific column names, they need to be URL Encoded. + 1st+rx, a%2Fb, bursty, crc+fail, cwnd, cx+active, cx+estab, cx+estab%2Fs, cx+to, + delay, destination+addr, dropped, dup+pkts, eid, elapsed, entity+id, jitter, + max+pdu, max+rate, min+pdu, min+rate, mng, name, ooo+pkts, pattern, pdu%2Fs+rx, + pdu%2Fs+tx, pps+rx+ll, pps+tx+ll, rcv+buf, replays, run, rx+ber, rx+bytes, + 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 + Example URL: /endp?fields=1st+rx,a%2Fb + + The data returned is going to look like: + { + '1st rx': X + 'a/b': X + 'bursty': X + 'crc fail': X + 'cwnd': X + 'cx active': X + 'cx estab': X + 'cx estab/s': X + 'cx to': X + 'delay': X + 'destination addr': X + 'dropped': X + 'dup pkts': X + 'eid': X + 'elapsed': X + 'entity id': X + 'jitter': X + 'max pdu': X + 'max rate': X + 'min pdu': X + 'min rate': X + 'mng': X + 'name': X + 'ooo pkts': X + 'pattern': X + 'pdu/s rx': X + 'pdu/s tx': X + 'pps rx ll': X + 'pps tx ll': X + 'rcv buf': X + 'replays': X + 'run': X + 'rx ber': X + 'rx bytes': X + 'rx drop %': X + 'rx dup %': X + 'rx ooo %': X + 'rx pdus': X + 'rx pkts ll': X + 'rx rate': X + 'rx rate (1 min)': X + 'rx rate (last)': X + 'rx rate ll': X + 'rx wrong dev': X + 'script': X + 'send buf': X + 'source addr': X + 'tcp mss': X + 'tcp rtx': X + 'tx bytes': X + 'tx pdus': X + 'tx pkts ll': X + 'tx rate': X + 'tx rate (1 min)': X + 'tx rate (last)': X + 'tx rate ll': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_endp(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/endp" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -350,35 +433,52 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /events + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - eid eid - entity+id entity id - event event - event+description event description - id id - name name - priority priority - time-stamp time-stamp - type type + ...examples how to call method(s) here... + Request one of these URLs: + /events/ + /events/$event_id + /events/before/$event_id + /events/between/$start_event_id/$end_event_id + /events/last/$event_count + /events/since/$event_id + + When requesting specific column names, they need to be URL Encoded. + eid, entity+id, event, event+description, id, name, priority, time-stamp, + type + Example URL: /events?fields=eid,entity+id + + The data returned is going to look like: + { + 'eid': X + 'entity id': X + 'event': X + 'event description': X + 'id': X + 'name': X + 'priority': X + 'time-stamp': X + 'type': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_events(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/events" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -390,53 +490,68 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /fileio + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - buf-rd buf-rd - buf-wr buf-wr - bytes-rd bytes-rd - bytes-wr bytes-wr - crc+fail crc fail - eid eid - entity+id entity id - files+%23 files # - files-read files-read - files-wr files-wr - io+fail io fail - max-file-sz max-file-sz - max-rd-bps max-rd-bps - max-rw-sz max-rw-sz - max-wr-bps max-wr-bps - min-file-sz min-file-sz - min-rd-bps min-rd-bps - min-rw-sz min-rw-sz - min-wr-bps min-wr-bps - name name - read-bps read-bps - rpt+timer rpt timer - rx-bps-20s rx-bps-20s - status status - tx-bps-20s tx-bps-20s - type type - write-bps write-bps + ...examples how to call method(s) here... + Request one of these URLs: + /fileio/ + /fileio/$endp_id + + When requesting specific column names, they need to be URL Encoded. + buf-rd, buf-wr, bytes-rd, bytes-wr, crc+fail, eid, entity+id, files+%23, files-read, + files-wr, io+fail, max-file-sz, max-rd-bps, max-rw-sz, max-wr-bps, min-file-sz, + min-rd-bps, min-rw-sz, min-wr-bps, name, read-bps, rpt+timer, rx-bps-20s, + status, tx-bps-20s, type, write-bps + Example URL: /fileio?fields=buf-rd,buf-wr + + The data returned is going to look like: + { + 'buf-rd': X + 'buf-wr': X + 'bytes-rd': X + 'bytes-wr': X + 'crc fail': X + 'eid': X + 'entity id': X + 'files #': X + 'files-read': X + 'files-wr': X + 'io fail': X + 'max-file-sz': X + 'max-rd-bps': X + 'max-rw-sz': X + 'max-wr-bps': X + 'min-file-sz': X + 'min-rd-bps': X + 'min-rw-sz': X + 'min-wr-bps': X + 'name': X + 'read-bps': X + 'rpt timer': X + 'rx-bps-20s': X + 'status': X + 'tx-bps-20s': X + 'type': X + 'write-bps': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_fileio(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/fileio" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -448,45 +563,59 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /generic + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - bps+rx bps rx - bps+tx bps tx - command command - dropped dropped - eid eid - elapsed elapsed - entity+id entity id - last+results last results - name name - pdu%2Fs+rx pdu/s rx - pdu%2Fs+tx pdu/s tx - rpt+timer rpt timer - rpt%23 rpt# - rx+bytes rx bytes - rx+pkts rx pkts - status status - tx+bytes tx bytes - tx+pkts tx pkts - type type + ...examples how to call method(s) here... + Request one of these URLs: + /generic/ + /generic/$endp_id + + When requesting specific column names, they need to be URL Encoded. + bps+rx, bps+tx, command, dropped, eid, elapsed, entity+id, last+results, + name, pdu%2Fs+rx, pdu%2Fs+tx, rpt+timer, rpt%23, rx+bytes, rx+pkts, status, tx+bytes, + tx+pkts, type + Example URL: /generic?fields=bps+rx,bps+tx + + The data returned is going to look like: + { + 'bps rx': X + 'bps tx': X + 'command': X + 'dropped': X + 'eid': X + 'elapsed': X + 'entity id': X + 'last results': X + 'name': X + 'pdu/s rx': X + 'pdu/s tx': X + 'rpt timer': X + 'rpt#': X + 'rx bytes': X + 'rx pkts': X + 'status': X + 'tx bytes': X + 'tx pkts': X + 'type': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_generic(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/generic" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -498,27 +627,37 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /gui-cli + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - na na + ...examples how to call method(s) here... + Request one of these URLs: + /gui-cli + + When requesting specific column names, they need to be URL Encoded. + na + + The data returned is going to look like: + { + 'na': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_gui_cli(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/gui-cli" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -530,73 +669,89 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /layer4 + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - %21conn !conn - acc.+denied acc. denied - bad-proto bad-proto - bad-url bad-url - bytes-rd bytes-rd - bytes-wr bytes-wr - dns-avg dns-avg - dns-max dns-max - dns-min dns-min - eid eid - elapsed elapsed - entity+id entity id - fb-avg fb-avg - fb-max fb-max - fb-min fb-min - ftp-host ftp-host - ftp-port ftp-port - ftp-stor ftp-stor - http-p http-p - http-r http-r - http-t http-t - login-denied login-denied - name name - nf+%284xx%29 nf (4xx) - other-err other-err - read read - redir redir - rpt+timer rpt timer - rslv-h rslv-h - rslv-p rslv-p - rx+rate rx rate - rx+rate+%281%C2%A0min%29 rx rate (1 min) - status status - timeout timeout - total-err total-err - total-urls total-urls - tx+rate tx rate - tx+rate+%281%C2%A0min%29 tx rate (1 min) - type type - uc-avg uc-avg - uc-max uc-max - uc-min uc-min - urls%2Fs urls/s - write write + ...examples how to call method(s) here... + Request one of these URLs: + /layer4/ + /layer4/$endp_id - # hidden columns: - rpt-time rpt-time + When requesting specific column names, they need to be URL Encoded. + %21conn, acc.+denied, bad-proto, bad-url, bytes-rd, bytes-wr, dns-avg, dns-max, + dns-min, eid, elapsed, entity+id, fb-avg, fb-max, fb-min, ftp-host, ftp-port, + ftp-stor, http-p, http-r, http-t, login-denied, name, nf+%284xx%29, other-err, + read, redir, rpt+timer, rslv-h, rslv-p, rx+rate, rx+rate+%281%C2%A0min%29, status, + timeout, total-err, total-urls, tx+rate, tx+rate+%281%C2%A0min%29, type, uc-avg, + uc-max, uc-min, urls%2Fs, write # hidden columns: + rpt-time + + Example URL: /layer4?fields=%21conn,acc.+denied + + The data returned is going to look like: + { + '!conn': X + 'acc. denied': X + 'bad-proto': X + 'bad-url': X + 'bytes-rd': X + 'bytes-wr': X + 'dns-avg': X + 'dns-max': X + 'dns-min': X + 'eid': X + 'elapsed': X + 'entity id': X + 'fb-avg': X + 'fb-max': X + 'fb-min': X + 'ftp-host': X + 'ftp-port': X + 'ftp-stor': X + 'http-p': X + 'http-r': X + 'http-t': X + 'login-denied': X + 'name': X + 'nf (4xx)': X + 'other-err': X + 'read': X + 'redir': X + 'rpt timer': X + 'rslv-h': X + 'rslv-p': X + 'rx rate': X + 'rx rate (1 min)': X + 'status': X + 'timeout': X + 'total-err': X + 'total-urls': X + 'tx rate': X + 'tx rate (1 min)': X + 'type': X + 'uc-avg': X + 'uc-max': X + 'uc-min': X + 'urls/s': X + 'write': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_layer4(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/layer4" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -608,110 +763,130 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /port + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - 4way+time+%28us%29 4way time (us) - activity activity - alias alias - anqp+time+%28us%29 anqp time (us) - ap ap - beacon beacon - bps+rx bps rx - bps+rx+ll bps rx ll - bps+tx bps tx - bps+tx+ll bps tx ll - bytes+rx+ll bytes rx ll - bytes+tx+ll bytes tx ll - channel channel - collisions collisions - connections connections - crypt crypt - cx+ago cx ago - cx+time+%28us%29 cx time (us) - device device - dhcp+%28ms%29 dhcp (ms) - down down - entity+id entity id - gateway+ip gateway ip - ip ip - ipv6+address ipv6 address - ipv6+gateway ipv6 gateway - key%2Fphrase key/phrase - login-fail login-fail - login-ok login-ok - logout-fail logout-fail - logout-ok logout-ok - mac mac - mask mask - misc misc - mode mode - mtu mtu - no+cx+%28us%29 no cx (us) - noise noise - parent+dev parent dev - phantom phantom - port port - port+type port type - pps+rx pps rx - pps+tx pps tx - qlen qlen - reset reset - retry+failed retry failed - rx+bytes rx bytes - rx+crc rx crc - rx+drop rx drop - rx+errors rx errors - rx+fifo rx fifo - rx+frame rx frame - rx+length rx length - rx+miss rx miss - rx+over rx over - rx+pkts rx pkts - rx-rate rx-rate - sec sec - signal signal - ssid ssid - status status - time-stamp time-stamp - tx+abort tx abort - tx+bytes tx bytes - tx+crr tx crr - tx+errors tx errors - tx+fifo tx fifo - tx+hb tx hb - tx+pkts tx pkts - tx+wind tx wind - tx-failed+%25 tx-failed % - tx-rate tx-rate - wifi+retries wifi retries + ...examples how to call method(s) here... + Request one of these URLs: + /port/ + /port/$shelf_id + /port/$shelf_id/$resource_id + /port/$shelf_id/$resource_id/$port_id + /ports/ + /ports/$shelf_id + /ports/$shelf_id/$resource_id + /ports/$shelf_id/$resource_id/$port_id - # hidden columns: - beacon_rx_signal beacon_rx_signal - port_cur_flags_h port_cur_flags_h - port_cur_flags_l port_cur_flags_l - port_supported_flags_h port_supported_flags_h - port_supported_flags_l port_supported_flags_l - resource resource - rx_multicast rx_multicast - tx_dropped tx_dropped + When requesting specific column names, they need to be URL Encoded. + 4way+time+%28us%29, activity, alias, anqp+time+%28us%29, ap, beacon, bps+rx, bps+rx+ll, + bps+tx, bps+tx+ll, bytes+rx+ll, bytes+tx+ll, channel, collisions, connections, + crypt, cx+ago, cx+time+%28us%29, device, dhcp+%28ms%29, down, entity+id, gateway+ip, + ip, ipv6+address, ipv6+gateway, key%2Fphrase, login-fail, login-ok, logout-fail, + logout-ok, mac, mask, misc, mode, mtu, no+cx+%28us%29, noise, parent+dev, phantom, + port, port+type, pps+rx, pps+tx, qlen, reset, retry+failed, rx+bytes, rx+crc, + rx+drop, rx+errors, rx+fifo, rx+frame, rx+length, rx+miss, rx+over, rx+pkts, + rx-rate, sec, signal, ssid, status, time-stamp, tx+abort, tx+bytes, tx+crr, + tx+errors, tx+fifo, tx+hb, tx+pkts, tx+wind, tx-failed+%25, tx-rate, wifi+retries, + # hidden columns: + beacon_rx_signal, port_cur_flags_h, port_cur_flags_l, port_supported_flags_h, + port_supported_flags_l, resource, rx_multicast, tx_dropped + + Example URL: /port?fields=4way+time+%28us%29,activity + + The data returned is going to look like: + { + '4way time (us)': X + 'activity': X + 'alias': X + 'anqp time (us)': X + 'ap': X + 'beacon': X + 'bps rx': X + 'bps rx ll': X + 'bps tx': X + 'bps tx ll': X + 'bytes rx ll': X + 'bytes tx ll': X + 'channel': X + 'collisions': X + 'connections': X + 'crypt': X + 'cx ago': X + 'cx time (us)': X + 'device': X + 'dhcp (ms)': X + 'down': X + 'entity id': X + 'gateway ip': X + 'ip': X + 'ipv6 address': X + 'ipv6 gateway': X + 'key/phrase': X + 'login-fail': X + 'login-ok': X + 'logout-fail': X + 'logout-ok': X + 'mac': X + 'mask': X + 'misc': X + 'mode': X + 'mtu': X + 'no cx (us)': X + 'noise': X + 'parent dev': X + 'phantom': X + 'port': X + 'port type': X + 'pps rx': X + 'pps tx': X + 'qlen': X + 'reset': X + 'retry failed': X + 'rx bytes': X + 'rx crc': X + 'rx drop': X + 'rx errors': X + 'rx fifo': X + 'rx frame': X + 'rx length': X + 'rx miss': X + 'rx over': X + 'rx pkts': X + 'rx-rate': X + 'sec': X + 'signal': X + 'ssid': X + 'status': X + 'time-stamp': X + 'tx abort': X + 'tx bytes': X + 'tx crr': X + 'tx errors': X + 'tx fifo': X + 'tx hb': X + 'tx pkts': X + 'tx wind': X + 'tx-failed %': X + 'tx-rate': X + 'wifi retries': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_port(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/port" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -723,52 +898,68 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /radiostatus + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - _links _links - antenna antenna - ap ap - capabilities capabilities - channel channel - country country - driver driver - entity+id entity id - entity+id entity id - frag frag - frequency frequency - max_sta max_sta - max_vap max_vap - max_vifs max_vifs - monitors_up monitors_up - monitors_up monitors_up - phantom phantom - port port - resource resource - rts rts - stations_down stations_down - stations_up stations_up - tx-power tx-power - vaps_down vaps_down - vaps_up vaps_up - verbose+debug verbose debug + ...examples how to call method(s) here... + Request one of these URLs: + /radiostatus/ + /radiostatus/$eid + /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 + Example URL: /radiostatus?fields=_links,antenna + + The data returned is going to look like: + { + '_links': X + 'antenna': X + 'ap': X + 'capabilities': X + 'channel': X + 'country': X + 'driver': X + 'entity id': X + 'entity id': X + 'frag': X + 'frequency': X + 'max_sta': X + 'max_vap': X + 'max_vifs': X + 'monitors_up': X + 'monitors_up': X + 'phantom': X + 'port': X + 'resource': X + 'rts': X + 'stations_down': X + 'stations_up': X + 'tx-power': X + 'vaps_down': X + 'vaps_up': X + 'verbose debug': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_radiostatus(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/radiostatus" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -780,54 +971,69 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /resource + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - bps-rx-3s bps-rx-3s - bps-tx-3s bps-tx-3s - cli-port cli-port - cpu cpu - ctrl-ip ctrl-ip - ctrl-port ctrl-port - eid eid - entity+id entity id - free+mem free mem - free+swap free swap - gps gps - hostname hostname - hw+version hw version - load load - max+if-up max if-up - max+staged max staged - mem mem - phantom phantom - ports ports - rx+bytes rx bytes - shelf shelf - sta+up sta up - sw+version sw version - swap swap - tx+bytes tx bytes + ...examples how to call method(s) here... + Request one of these URLs: + /resource/ + /resource/$shelf_id + /resource/$shelf_id/$resource_id - # hidden columns: - timestamp timestamp + When requesting specific column names, they need to be URL Encoded. + bps-rx-3s, bps-tx-3s, cli-port, cpu, ctrl-ip, ctrl-port, eid, entity+id, + free+mem, free+swap, gps, hostname, hw+version, load, max+if-up, max+staged, + mem, phantom, ports, rx+bytes, shelf, sta+up, sw+version, swap, tx+bytes, + # hidden columns: + timestamp + + Example URL: /resource?fields=bps-rx-3s,bps-tx-3s + + The data returned is going to look like: + { + 'bps-rx-3s': X + 'bps-tx-3s': X + 'cli-port': X + 'cpu': X + 'ctrl-ip': X + 'ctrl-port': X + 'eid': X + 'entity id': X + 'free mem': X + 'free swap': X + 'gps': X + 'hostname': X + 'hw version': X + 'load': X + 'max if-up': X + 'max staged': X + 'mem': X + 'phantom': X + 'ports': X + 'rx bytes': X + 'shelf': X + 'sta up': X + 'sw version': X + 'swap': X + 'tx bytes': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_resource(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/resource" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -839,27 +1045,45 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /scan + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - na na + ...examples how to call method(s) here... + Request one of these URLs: + /scan-results/ + /scan-results/$shelf_id/$resource_id/$port_id + /scan-results/$shelf_id/$resource_id/$port_id/$bssid + /scan/ + /scan/$shelf_id/$resource_id/$port_id + /scan/$shelf_id/$resource_id/$port_id/$bssid + /scanresults/ + /scanresults/$shelf_id/$resource_id/$port_id + /scanresults/$shelf_id/$resource_id/$port_id/$bssid + + When requesting specific column names, they need to be URL Encoded. + na + + The data returned is going to look like: + { + 'na': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_scan(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/scan" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -871,42 +1095,56 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /stations + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - ap ap - auth-for auth-for - capabilities capabilities - entity+id entity id - idle idle - roam-duration roam-duration - rx+bytes rx bytes - rx+pkts rx pkts - rx+rate rx rate - signal signal - station+bssid station bssid - tx+bytes tx bytes - tx+pkts tx pkts - tx+rate tx rate - tx+retries tx retries - tx-failed tx-failed + ...examples how to call method(s) here... + Request one of these URLs: + /stations/ + /stations/$mac + + When requesting specific column names, they need to be URL Encoded. + ap, auth-for, capabilities, entity+id, idle, roam-duration, rx+bytes, rx+pkts, + rx+rate, signal, station+bssid, tx+bytes, tx+pkts, tx+rate, tx+retries, tx-failed, + + Example URL: /stations?fields=ap,auth-for + + The data returned is going to look like: + { + 'ap': X + 'auth-for': X + 'capabilities': X + 'entity id': X + 'idle': X + 'roam-duration': X + 'rx bytes': X + 'rx pkts': X + 'rx rate': X + 'signal': X + 'station bssid': X + 'tx bytes': X + 'tx pkts': X + 'tx rate': X + 'tx retries': X + 'tx-failed': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_stations(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/stations" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -918,27 +1156,43 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /status-msg + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - na na + ...examples how to call method(s) here... + Request one of these URLs: + /status-msg + /status-msg/$session + /status-msg/$session/$id + /status-msg/$session/$id/ws-msg,... + /status-msg/$session/all + /status-msg/$session/this + /status-msg/sessions + + When requesting specific column names, they need to be URL Encoded. + na + + The data returned is going to look like: + { + 'na': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_status_msg(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/status-msg" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -950,31 +1204,45 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /test-group + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - cross+connects cross connects - entity+id entity id - name name - run run - script script + ...examples how to call method(s) here... + Request one of these URLs: + /test-group/ + /test-group/$id + /test-groups/ + /test-groups/$id + + When requesting specific column names, they need to be URL Encoded. + cross+connects, entity+id, name, run, script + Example URL: /test-group?fields=cross+connects,entity+id + + The data returned is going to look like: + { + 'cross connects': X + 'entity id': X + 'name': X + 'run': X + 'script': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_test_group(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/test-group" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -986,30 +1254,44 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /text + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - eid eid - name name - text text - type type + ...examples how to call method(s) here... + Request one of these URLs: + /text/ + /text/$group + /text/$group/$class + /text/$group/$class/$key + + When requesting specific column names, they need to be URL Encoded. + eid, name, text, type + Example URL: /text?fields=eid,name + + The data returned is going to look like: + { + 'eid': X + 'name': X + 'text': X + 'type': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_text(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/text" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1021,43 +1303,66 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /voip + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - bps+rx+a bps rx a - bps+rx+b bps rx b - delay+a+%E2%86%90+b delay a ← b - delay+a+%E2%86%92+b delay a → b - eid eid - endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29 endpoints (a ↔ b) - entity+id entity id - jitter+a+%E2%86%90+b jitter a ← b - jitter+a+%E2%86%92+b jitter a → b - name name - pkt+tx+a%C2%A0%E2%86%90%C2%A0b pkt tx a ← b - pkt+tx+a%C2%A0%E2%86%92%C2%A0b pkt tx a → b - rpt+timer rpt timer - rx+drop+%25+a rx drop % a - rx+drop+%25+b rx drop % b - state state - type type + ...examples how to call method(s) here... + Request one of these URLs: + /voip-endp/ + /voip-endp/$endp_id + /voip-ep/ + /voip-ep/$endp_id + /voip/ + /voip/$cx_id + /voip_endp/ + /voip_endp/$endp_id + /voip_ep/ + /voip_ep/$endp_id + + When requesting specific column names, they need to be URL Encoded. + bps+rx+a, bps+rx+b, delay+a+%E2%86%90+b, delay+a+%E2%86%92+b, eid, endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29, + entity+id, jitter+a+%E2%86%90+b, jitter+a+%E2%86%92+b, name, pkt+tx+a%C2%A0%E2%86%90%C2%A0b, + pkt+tx+a%C2%A0%E2%86%92%C2%A0b, rpt+timer, rx+drop+%25+a, rx+drop+%25+b, state, + type + Example URL: /voip?fields=bps+rx+a,bps+rx+b + + The data returned is going to look like: + { + 'bps rx a': X + 'bps rx b': X + 'delay a ← b': X + 'delay a → b': X + 'eid': X + 'endpoints (a ↔ b)': X + 'entity id': X + 'jitter a ← b': X + 'jitter a → b': X + 'name': X + 'pkt tx a ← b': X + 'pkt tx a → b': X + 'rpt timer': X + 'rx drop % a': X + 'rx drop % b': X + 'state': X + 'type': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_voip(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/voip" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1069,63 +1374,79 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /voip-endp + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - calls+answered calls answered - calls+attempted calls attempted - calls+completed calls completed - calls+failed calls failed - cf+404 cf 404 - cf+408 cf 408 - cf+busy cf busy - cf+canceled cf canceled - delay delay - destination+addr destination addr - dropped dropped - dup+pkts dup pkts - eid eid - elapsed elapsed - entity+id entity id - jb+cur jb cur - jb+over jb over - jb+silence jb silence - jb+under jb under - jitter jitter - mng mng - name name - ooo+pkts ooo pkts - pesq pesq - pesq+bklg pesq bklg - pesq%23 pesq# - reg+state reg state - rst rst - rtp+rtt rtp rtt - run run - rx+bytes rx bytes - rx+pkts rx pkts - source+addr source addr - state state - tx+bytes tx bytes - tx+pkts tx pkts - vad+pkts vad pkts + ...examples how to call method(s) here... + Request one of these URLs: + /voip-endp/ + /voip-endp/$endp_id + + When requesting specific column names, they need to be URL Encoded. + calls+answered, calls+attempted, calls+completed, calls+failed, cf+404, cf+408, + cf+busy, cf+canceled, delay, destination+addr, dropped, dup+pkts, eid, elapsed, + entity+id, jb+cur, jb+over, jb+silence, jb+under, jitter, mng, name, ooo+pkts, + pesq, pesq+bklg, pesq%23, reg+state, rst, rtp+rtt, run, rx+bytes, rx+pkts, + source+addr, state, tx+bytes, tx+pkts, vad+pkts + Example URL: /voip-endp?fields=calls+answered,calls+attempted + + The data returned is going to look like: + { + 'calls answered': X + 'calls attempted': X + 'calls completed': X + 'calls failed': X + 'cf 404': X + 'cf 408': X + 'cf busy': X + 'cf canceled': X + 'delay': X + 'destination addr': X + 'dropped': X + 'dup pkts': X + 'eid': X + 'elapsed': X + 'entity id': X + 'jb cur': X + 'jb over': X + 'jb silence': X + 'jb under': X + 'jitter': X + 'mng': X + 'name': X + 'ooo pkts': X + 'pesq': X + 'pesq bklg': X + 'pesq#': X + 'reg state': X + 'rst': X + 'rtp rtt': X + 'run': X + 'rx bytes': X + 'rx pkts': X + 'source addr': X + 'state': X + 'tx bytes': X + 'tx pkts': X + 'vad pkts': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_voip_endp(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/voip-endp" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1137,61 +1458,82 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /vr + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - active+ipv6+router active ipv6 router - bgp+4byte+as bgp 4byte as - bgp+damping bgp damping - bgp+peers bgp peers - cluster+id cluster id - collision+domain+id collision domain id - confederation+id confederation id - damping+half+life damping half life - damping+max+suppress damping max suppress - damping+reuse damping reuse - damping+suppress damping suppress - entity+id entity id - height height - ipv6+radv ipv6 radv - is+bgp+reflector is bgp reflector - local+as local as - multicast+routing multicast routing - name name - netsmith-state netsmith-state - notes notes - pad pad - ripv2 ripv2 - router+connections router connections - router+id router id - router+id router id - use+confederation use confederation - use+existing+cfg use existing cfg - use+ospf use ospf - use+rip+dft+route use rip dft route - using+bgp using bgp - using+olsr using olsr - width width - x x - xorp+sha xorp sha - y y + ...examples how to call method(s) here... + Request one of these URLs: + /vr-cx/ + /vr-cx/$shelf_id/$resource_id/$port_id + /vr/ + /vr/$shelf_id/$resource_id + /vrcx/ + /vrcx/$shelf_id/$resource_id/$port_id + + When requesting specific column names, they need to be URL Encoded. + active+ipv6+router, bgp+4byte+as, bgp+damping, bgp+peers, cluster+id, collision+domain+id, + confederation+id, damping+half+life, damping+max+suppress, damping+reuse, + damping+suppress, entity+id, height, ipv6+radv, is+bgp+reflector, local+as, + multicast+routing, name, netsmith-state, notes, pad, ripv2, router+connections, + router+id, router+id, use+confederation, use+existing+cfg, use+ospf, use+rip+dft+route, + using+bgp, using+olsr, width, x, xorp+sha, y + Example URL: /vr?fields=active+ipv6+router,bgp+4byte+as + + The data returned is going to look like: + { + 'active ipv6 router': X + 'bgp 4byte as': X + 'bgp damping': X + 'bgp peers': X + 'cluster id': X + 'collision domain id': X + 'confederation id': X + 'damping half life': X + 'damping max suppress': X + 'damping reuse': X + 'damping suppress': X + 'entity id': X + 'height': X + 'ipv6 radv': X + 'is bgp reflector': X + 'local as': X + 'multicast routing': X + 'name': X + 'netsmith-state': X + 'notes': X + 'pad': X + 'ripv2': X + 'router connections': X + 'router id': X + 'router id': X + 'use confederation ': X + 'use existing cfg': X + 'use ospf': X + 'use rip dft route': X + 'using bgp': X + 'using olsr': X + 'width': X + 'x': X + 'xorp sha': X + 'y': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_vr(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/vr" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1203,45 +1545,59 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /vrcx + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - entity+id entity id - height height - interface+cost interface cost - local-a local-a - local-b local-b - netsmith-state netsmith-state - remote-a remote-a - remote-b remote-b - resource resource - rip+metric rip metric - vrrp+id vrrp id - vrrp+interval vrrp interval - vrrp+ip vrrp ip - vrrp+ip-prefix vrrp ip-prefix - vrrp+priority vrrp priority - wan+link wan link - width width - x x - y y + ...examples how to call method(s) here... + Request one of these URLs: + /vrcx/ + /vrcx/$shelf_id/$resource_id/$port_id + + When requesting specific column names, they need to be URL Encoded. + entity+id, height, interface+cost, local-a, local-b, netsmith-state, remote-a, + remote-b, resource, rip+metric, vrrp+id, vrrp+interval, vrrp+ip, vrrp+ip-prefix, + vrrp+priority, wan+link, width, x, y + Example URL: /vrcx?fields=entity+id,height + + The data returned is going to look like: + { + 'entity id': X + 'height': X + 'interface cost': X + 'local-a': X + 'local-b': X + 'netsmith-state': X + 'remote-a': X + 'remote-b': X + 'resource': X + 'rip metric': X + 'vrrp id': X + 'vrrp interval': X + 'vrrp ip': X + 'vrrp ip-prefix': X + 'vrrp priority': X + 'wan link': X + 'width': X + 'x': X + 'y': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_vrcx(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/vrcx" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1253,37 +1609,60 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /wl + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - bps+rx+a bps rx a - bps+rx+b bps rx b - eid eid - endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29 endpoints (a ↔ b) - entity+id entity id - k-m k-m - name name - pkt+tx+a%C2%A0%E2%86%90%C2%A0b pkt tx a ← b - pkt+tx+a%C2%A0%E2%86%92%C2%A0b pkt tx a → b - rpt+timer rpt timer - state state + ...examples how to call method(s) here... + Request one of these URLs: + /wl-endp/ + /wl-endp/$wl_ep_id + /wl-ep/ + /wl-ep/$wl_ep_id + /wl/ + /wl/$wl_id + /wl_endp/ + /wl_endp/$wl_ep_id + /wl_ep/ + /wl_ep/$wl_ep_id + /wlendp/$wl_ep_id + + When requesting specific column names, they need to be URL Encoded. + bps+rx+a, bps+rx+b, eid, endpoints+%28a%C2%A0%E2%86%94%C2%A0b%29, entity+id, k-m, + name, pkt+tx+a%C2%A0%E2%86%90%C2%A0b, pkt+tx+a%C2%A0%E2%86%92%C2%A0b, rpt+timer, + state + Example URL: /wl?fields=bps+rx+a,bps+rx+b + + The data returned is going to look like: + { + 'bps rx a': X + 'bps rx b': X + 'eid': X + 'endpoints (a ↔ b)': X + 'entity id': X + 'k-m': X + 'name': X + 'pkt tx a ← b': X + 'pkt tx a → b': X + 'rpt timer': X + 'state': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_wl(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/wl" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1295,61 +1674,77 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /wl-endp + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - buffer buffer - corrupt+1 corrupt 1 - corrupt+2 corrupt 2 - corrupt+3 corrupt 3 - corrupt+4 corrupt 4 - corrupt+5 corrupt 5 - corrupt+6 corrupt 6 - delay delay - dropfreq+%25 dropfreq % - dropped dropped - dup+pkts dup pkts - dupfreq+%25 dupfreq % - eid eid - elapsed elapsed - extrabuf extrabuf - failed-late failed-late - jitfreq+%25 jitfreq % - max+rate max rate - maxjitter maxjitter - maxlate maxlate - name name - ooo+pkts ooo pkts - qdisc qdisc - reordfrq+%25 reordfrq % - run run - rx+bytes rx bytes - rx+pkts rx pkts - script script - serdelay serdelay - tx+bytes tx bytes - tx+drop+%25 tx drop % - tx+pkts tx pkts - tx+rate tx rate - tx-failed tx-failed - wps wps + ...examples how to call method(s) here... + Request one of these URLs: + /wl-endp/ + /wl-endp/$wl_ep_id + + When requesting specific column names, they need to be URL Encoded. + buffer, corrupt+1, corrupt+2, corrupt+3, corrupt+4, corrupt+5, corrupt+6, + delay, dropfreq+%25, dropped, dup+pkts, dupfreq+%25, eid, elapsed, extrabuf, + failed-late, jitfreq+%25, max+rate, maxjitter, maxlate, name, ooo+pkts, qdisc, + reordfrq+%25, run, rx+bytes, rx+pkts, script, serdelay, tx+bytes, tx+drop+%25, + tx+pkts, tx+rate, tx-failed, wps + Example URL: /wl-endp?fields=buffer,corrupt+1 + + The data returned is going to look like: + { + 'buffer': X + 'corrupt 1': X + 'corrupt 2': X + 'corrupt 3': X + 'corrupt 4': X + 'corrupt 5': X + 'corrupt 6': X + 'delay': X + 'dropfreq %': X + 'dropped': X + 'dup pkts': X + 'dupfreq %': X + 'eid': X + 'elapsed': X + 'extrabuf': X + 'failed-late': X + 'jitfreq %': X + 'max rate': X + 'maxjitter': X + 'maxlate': X + 'name': X + 'ooo pkts': X + 'qdisc': X + 'reordfrq %': X + 'run': X + 'rx bytes': X + 'rx pkts': X + 'script': X + 'serdelay': X + 'tx bytes': X + 'tx drop %': X + 'tx pkts': X + 'tx rate': X + 'tx-failed': X + 'wps': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_wl_endp(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/wl-endp" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1361,27 +1756,38 @@ class LFJsonGet(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /ws-msg + Notes for type requests - URL Encoded Column Names JSON keys - use these in a URL use these to get value - ------------------ ---------------------- - na na + ...examples how to call method(s) here... + Request one of these URLs: + /ws-msg/ + /ws-msg/$sessionid + + When requesting specific column names, they need to be URL Encoded. + na + + The data returned is going to look like: + { + 'na': X + } ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def get_ws_msg(self, - fields=[], + shelf=1, + resource=None, + name=None, + requested_col_names=[], debug_=False): debug_ |= self.debug url = "/ws-msg" - if (fields is not None) and (type(fields) is not list): - raise ValueError("fields must be a None or a list") + 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 (fields is not None) and (len(fields) > 0): - for field in fields: + if (requested_col_names is not None) and (len(requested_col_names) > 0): + for field in requested_col_names: if field.index(" ") > -1 : raise ValueError("field should be URL encoded: [%s]" % (field)) - url += "?fields=%s" % (",".join(fields)) + url += "?requested_col_names=%s" % (",".join(requested_col_names)) response = self.json_get(url, debug_=debug_) if response is None: return None @@ -1415,23 +1821,28 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_arm_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_arm_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + cpu_id=None, + mx_pkt_sz=None, + pkt_sz=None, + port=None, + pps=None, + resource=None, + shelf=None, + tos=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_arm_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -1454,12 +1865,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_bgp_peer + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_bgp_peer ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_bgp_peer_flags(Enum): + class add_bgp_peer_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -1468,36 +1882,67 @@ class LFJsonPost(LFCliBase): PEER_CONFED_MEMBER = 0x4 # Sets corresponding Xorp flag in BGP Peer section. PEER_UNICAST_V4 = 0x8 # Sets corresponding Xorp flag in BGP Peer section. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_bgp_peer_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_bgp_peer_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_bgp_peer_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_bgp_peer_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_bgp_peer(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "as" : p_as, @@ -1522,17 +1967,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_bond + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_bond ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_bond(self, - network_devs=None, - port=None, - resource=None, - shelf=None, + network_devs=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_bond(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "network_devs" : network_devs, @@ -1549,28 +1999,38 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_br + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_br ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_br_br_flags(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_br_br_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_br_br_flags.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" none = 0 # no features stp_enabled = 1 # Enable Spanning Tree Protocol (STP) 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_br(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "br_aging_time" : br_aging_time, @@ -1593,26 +2053,36 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_cd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_cd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_cd_flags(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_cd_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_cd_flags.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" ERR = 2 # Set to kernel mode. RUNNING = 1 # Set to running state. def post_add_cd(self, - alias=None, - bps=None, - flags=None, - report_timer=None, - resource=None, - shelf=None, - state=None, - type=None, + alias=None, + bps=None, + flags=None, + report_timer=None, + resource=None, + shelf=None, + state=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_cd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -1633,15 +2103,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_cd_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_cd_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_endp(self, - cd=None, - endp=None, + cd=None, + endp=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_cd_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd" : cd, @@ -1656,15 +2131,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_cd_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_cd_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_vr(self, - cd=None, - vr=None, + cd=None, + vr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_cd_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd" : cd, @@ -1679,12 +2159,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_chamber + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_chamber ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_chamber_chamber_flags(Enum): + class add_chamber_chamber_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -1692,44 +2175,75 @@ class LFJsonPost(LFCliBase): PHANTOM = 0x1 # (1) Chamber is not actually here right now. VIRTUAL = 0x2 # (2) No real chamber, open-air grouping of equipment. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_chamber_chamber_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_chamber_chamber_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_chamber_chamber_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_chamber_chamber_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_chamber(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chamber_type" : chamber_type, @@ -1762,29 +2276,39 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_chamber_cx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_chamber_cx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_chamber_cx_chamber_cx_flags(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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) TERMINATED = 2 # (2) Connection is terminated, signal shall not pass! 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_chamber_cx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "a_id" : a_id, @@ -1808,16 +2332,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_chamber_path + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_chamber_path ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_chamber_path(self, - chamber=None, - content=None, - path=None, + chamber=None, + content=None, + path=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_chamber_path(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chamber" : chamber, @@ -1833,12 +2362,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_channel_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_channel_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_channel_group_types(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 e_m = "e&m" # Channel(s) are signalled using E&M signalling (specific fcshdlc = "fcshdlc" # The zapdel driver performs HDLC encoding and decoding on the @@ -1855,15 +2389,20 @@ 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, + channels=None, + idle_flag=None, + mtu=None, + resource=None, + shelf=None, + span_num=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_channel_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -1884,17 +2423,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_cx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_cx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cx(self, - alias=None, - rx_endp=None, - test_mgr=None, - tx_endp=None, + alias=None, + rx_endp=None, + test_mgr=None, + tx_endp=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_cx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -1911,12 +2455,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_dut + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_dut ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_dut_dut_flags(Enum): + class add_dut_dut_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -1934,52 +2481,83 @@ class LFJsonPost(LFCliBase): WPA2 = 0x20 # Use WPA2 encryption on all ssids, deprecated, see add_dut_ssid. WPA3 = 0x100 # Use WPA3 encryption on all ssids, deprecated, see add_dut_extras. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_dut_dut_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_dut_dut_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_dut_dut_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_dut_dut_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_dut(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "antenna_count1" : antenna_count1, @@ -2020,15 +2598,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_dut_notes + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_dut_notes ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_dut_notes(self, - dut=None, - text=None, + dut=None, + text=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_dut_notes(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "dut" : dut, @@ -2043,12 +2626,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_dut_ssid + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_dut_ssid ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_dut_ssid_dut_flags(Enum): + class add_dut_ssid_dut_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2060,31 +2646,62 @@ class LFJsonPost(LFCliBase): WPA2 = 0x20 # Use WPA2 encryption WPA3 = 0x100 # Use WPA3 encryption + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_dut_ssid_dut_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_dut_ssid_dut_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_dut_ssid_dut_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_dut_ssid_dut_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_add_dut_ssid(self, - bssid=None, - name=None, - passwd=None, - ssid=None, - ssid_flags=None, - ssid_flags_mask=None, - ssid_idx=None, + bssid=None, + name=None, + passwd=None, + ssid=None, + ssid_flags=None, + ssid_flags_mask=None, + ssid_idx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_dut_ssid(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "bssid" : bssid, @@ -2104,12 +2721,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_endp_payload_pattern(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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) PRBS_15_0_14 = "PRBS_15_0_14" # PRBS (see above) PRBS_4_0_3 = "PRBS_4_0_3" # Use linear feedback shift register to generate pseudo random sequence. @@ -2123,6 +2745,11 @@ class LFJsonPost(LFCliBase): zeros = "zeros" # payload is all zeros (00) class add_endp_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 custom_mc_udp = "custom_mc_udp" # LF Multicast UDP IPv4 custom_tcp = "custom_tcp" # LF TCP IPv4 frame with custom options @@ -2138,24 +2765,29 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -2185,17 +2817,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_event + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_event ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_event(self, - details=None, - event_id=None, - name=None, - priority=None, + details=None, + event_id=None, + name=None, + priority=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_event(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "details" : details, @@ -2212,12 +2849,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_file_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_file_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_file_endp_fio_flags(Enum): + class add_file_endp_fio_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2232,22 +2872,53 @@ class LFJsonPost(LFCliBase): UNMOUNT_LAZY = 0x80 # (128) Use -l flag when calling umount USE_FSTATFS = 0x100 # (256) Use fstatfs system call to verify file-system type when opening files. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_file_endp_fio_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_file_endp_fio_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_file_endp_fio_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_file_endp_fio_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_file_endp_payload_pattern(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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) PRBS_15_0_14 = "PRBS_15_0_14" # PRBS (see above) PRBS_4_0_3 = "PRBS_4_0_3" # Use linear feedback shift register to generate pseudo random sequence. @@ -2262,25 +2933,30 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_file_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -2311,18 +2987,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_gen_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_gen_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_gen_endp(self, - alias=None, - port=None, - resource=None, - shelf=None, - type=None, + alias=None, + port=None, + resource=None, + shelf=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_gen_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -2340,19 +3021,24 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_gre + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_gre ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + port=None, + remote_lower_ip=None, + report_timer=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_gre(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "local_lower_ip" : local_lower_ip, @@ -2371,38 +3057,72 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_group_flags(Enum): + class add_group_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 group_total_rates = 0x4 # Set rates as total for group. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_group_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_group_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_group_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_group_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_add_group(self, - flags=None, - flags_mask=None, - name=None, + flags=None, + flags_mask=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "flags" : flags, @@ -2418,12 +3138,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_l4_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_l4_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_l4_endp_http_auth_type(Enum): + class add_l4_endp_http_auth_type(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2432,22 +3155,51 @@ class LFJsonPost(LFCliBase): GSSNEGOTIATE = 0x4 # GSS authentication NTLM = 0x8 # NTLM authentication + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_http_auth_type.add_flags('bridge', 'dhcp') + print('value now: '+add_l4_endp_http_auth_type.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_http_auth_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_l4_endp_http_auth_type.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_l4_endp_proxy_auth_type(Enum): + class add_l4_endp_proxy_auth_type(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2464,66 +3216,126 @@ class LFJsonPost(LFCliBase): USE_IPV6 = 0x400 # 1024 Resolve URL is IPv6. Will use IPv4 if not selected. USE_PROXY_CACHE = 0x20 # 32 Use proxy cache + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_proxy_auth_type.add_flags('bridge', 'dhcp') + print('value now: '+add_l4_endp_proxy_auth_type.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_proxy_auth_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_l4_endp_proxy_auth_type.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_l4_endp_type(Enum): + class add_l4_endp_type(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 l4_generic = 0x0 # Layer 4 type + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_type.add_flags('bridge', 'dhcp') + print('value now: '+add_l4_endp_type.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_l4_endp_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_l4_endp_type.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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_l4_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -2557,12 +3369,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_monitor + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_monitor ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_monitor_flags(Enum): + class add_monitor_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2570,32 +3385,63 @@ class LFJsonPost(LFCliBase): disable_ht80 = 0x8000000 # Disable HT80 (for AC chipset NICs only) ht160_enable = 0x100000000 # Enable HT160 mode. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_monitor_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_monitor_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_monitor_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_monitor_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_add_monitor(self, - aid=None, - ap_name=None, - bssid=None, - flags=None, - flags_mask=None, - radio=None, - resource=None, - shelf=None, + aid=None, + ap_name=None, + bssid=None, + flags=None, + flags_mask=None, + radio=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_monitor(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aid" : aid, @@ -2616,21 +3462,26 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_mvlan + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_mvlan ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + index=None, + mac=None, + old_name=None, + port=None, + report_timer=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_mvlan(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "flags" : flags, @@ -2651,34 +3502,39 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_ppp_link + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_ppp_link ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_ppp_link(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "auth" : auth, @@ -2712,12 +3568,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_profile_profile_flags(Enum): + class add_profile_profile_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2733,22 +3592,53 @@ class LFJsonPost(LFCliBase): WPA2 = 0x8 # Use WPA2 encryption WPA3 = 0x20 # Use WPA3 encryption + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_profile_profile_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_profile_profile_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_profile_profile_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_profile_profile_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_profile_wifi_mode(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 abg = "abg" # 802.11abg @@ -2780,22 +3670,27 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias_prefix" : alias_prefix, @@ -2823,15 +3718,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_profile_notes + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_profile_notes ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_profile_notes(self, - dut=None, - text=None, + dut=None, + text=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_profile_notes(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "dut" : dut, @@ -2846,18 +3746,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_rdd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_rdd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_rdd(self, - peer_ifname=None, - port=None, - report_timer=None, - resource=None, - shelf=None, + peer_ifname=None, + port=None, + report_timer=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_rdd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "peer_ifname" : peer_ifname, @@ -2875,17 +3780,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_sec_ip + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_sec_ip ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_sec_ip(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ip_list" : ip_list, @@ -2902,12 +3812,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_sta + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_sta ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_sta_flags(Enum): + class add_sta_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -2947,22 +3860,53 @@ class LFJsonPost(LFCliBase): 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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + 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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - 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 @@ -2980,6 +3924,11 @@ class LFJsonPost(LFCliBase): 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 @@ -2988,29 +3937,34 @@ 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, + 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_sta(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ampdu_density" : ampdu_density, @@ -3045,12 +3999,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_t1_span + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_t1_span ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_t1_span_buildout(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_t1_span_buildout.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_t1_span_buildout.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_15db = 6 # -15db (CSU) p_22_5db = 7 # -22.5db (CSU) p_7_5db = 5 # -7.5db (CSU) @@ -3063,20 +4022,25 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_t1_span(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "buildout" : buildout, @@ -3102,16 +4066,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_text_blob + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_text_blob ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_text_blob(self, - name=None, - text=None, - type=None, + name=None, + text=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_text_blob(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -3127,15 +4096,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_tgcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_tgcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tgcx(self, - cxname=None, - tgname=None, + cxname=None, + tgname=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_tgcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cxname" : cxname, @@ -3150,16 +4124,26 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_threshold + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_threshold ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_threshold_thresh_id(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_threshold_thresh_id.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_threshold_thresh_id.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Delete_Marked = -3 # Delete any marked. Mark_All = -2 # Mark all class add_threshold_thresh_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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. RX_BPS_RATE_OOR_1m = 5 # rx-bps over last 1 minute is out of range. RX_BPS_RATE_OOR_30S = 3 # rx-bps over last 30 seconds is out of range. @@ -3172,12 +4156,17 @@ class LFJsonPost(LFCliBase): def post_add_threshold(self, - endp=None, - thresh_id=None, - thresh_max=None, - thresh_min=None, - thresh_type=None, + endp=None, + thresh_id=None, + thresh_max=None, + thresh_min=None, + thresh_type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_threshold(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp" : endp, @@ -3195,14 +4184,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_tm + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_tm ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tm(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_tm(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -3216,12 +4210,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_traffic_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_traffic_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_traffic_profile_traffic_profile_flags(Enum): + class add_traffic_profile_traffic_profile_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3229,22 +4226,53 @@ class LFJsonPost(LFCliBase): IPERF_UDP = 0x4 # If Iperf, should use UDP. If not set, then will use TCP. UP = 0x1 # Upload direction (this not set means download) + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_traffic_profile_traffic_profile_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_traffic_profile_traffic_profile_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_traffic_profile_traffic_profile_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_traffic_profile_traffic_profile_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_traffic_profile_wifi_mode(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_traffic_profile_wifi_mode.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_traffic_profile_wifi_mode.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Iperf3_Client = "Iperf3-Client" # iperf3 client Iperf3_Server = "Iperf3-Server" # iperf3 server as_is = "as_is" # Make no changes to current configuration @@ -3255,17 +4283,22 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_traffic_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "instance_count" : instance_count, @@ -3288,15 +4321,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_traffic_profile_notes + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_traffic_profile_notes ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_traffic_profile_notes(self, - dut=None, - text=None, + dut=None, + text=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_traffic_profile_notes(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "dut" : dut, @@ -3311,12 +4349,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vap + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vap ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_vap_flags(Enum): + class add_vap_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3349,22 +4390,53 @@ class LFJsonPost(LFCliBase): wep_enable = 0x200 # Enable WEP Encryption wpa2_enable = 0x400 # Enable WPA2 Encryption + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vap_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_vap_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vap_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_vap_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_vap_mode(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vap_mode.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_vap_mode.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" p_802_11a = 1 # 802.11a AUTO = 0 # 802.11g abg = 4 # 802.11abg @@ -3383,27 +4455,32 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vap(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ap_name" : ap_name, @@ -3436,12 +4513,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_venue + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_venue ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_venue_freq_24(Enum): + class add_venue_freq_24(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3450,22 +4530,51 @@ class LFJsonPost(LFCliBase): Ch_2 = 0x2 # Channel 2 Ch_3 = 0x4 # Channel 3 + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_venue_freq_24.add_flags('bridge', 'dhcp') + print('value now: '+add_venue_freq_24.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_venue_freq_24.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_venue_freq_24.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_venue_freq_5(Enum): + class add_venue_freq_5(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3497,34 +4606,65 @@ class LFJsonPost(LFCliBase): Ch_60 = 0x200 # Channel 60 5300 Ch_64 = 0x400 # Channel 64 5320 + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_venue_freq_5.add_flags('bridge', 'dhcp') + print('value now: '+add_venue_freq_5.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_venue_freq_5.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_venue_freq_5.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_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, + freq_24=None, + freq_5=None, + resource=None, + shelf=None, + venu_id=None, + x1=None, + x2=None, + y1=None, + y2=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_venue(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "description" : description, @@ -3547,19 +4687,24 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vlan + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vlan ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vlan(self, - old_name=None, - port=None, - report_timer=None, - resource=None, - shelf=None, - vid=None, + old_name=None, + port=None, + report_timer=None, + resource=None, + shelf=None, + vid=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vlan(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "old_name" : old_name, @@ -3578,30 +4723,35 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_voip_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_voip_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_voip_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -3631,12 +4781,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_vr_flags(Enum): + class add_vr_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3654,34 +4807,65 @@ class LFJsonPost(LFCliBase): USE_XORP_OSPF = 0x1 # Enable Xorp router daemon with OSPF (IPv4) protocol USE_XORP_SHA = 0x4 # Enable Telcordia's Xorp SHA option (requires OSPF to be enabled) + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vr_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_vr_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vr_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_vr_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_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, + flags=None, + height=None, + notes=None, + resource=None, + shelf=None, + vr_id=None, + width=None, + x=None, + y=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -3704,12 +4888,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vr_bgp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vr_bgp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_vr_bgp_flags(Enum): + class add_vr_bgp_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3719,36 +4906,67 @@ class LFJsonPost(LFCliBase): ENABLE_BGP = 0x20 # Set this to zero if you don't want BGP on this VR. ROUTE_REFLECTOR = 0x80 # Act as BGP Route Reflector. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vr_bgp_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_vr_bgp_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vr_bgp_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_vr_bgp_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vr_bgp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "bgp_id" : bgp_id, @@ -3773,12 +4991,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vrcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vrcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_vrcx_flags(Enum): + class add_vrcx_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3797,55 +5018,86 @@ class LFJsonPost(LFCliBase): use_multicast = 0x800 # Use this interface for multicast and-rp use_vrrp = 0x1000 # Use this interface for VRRP + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vrcx_flags.add_flags('bridge', 'dhcp') + print('value now: '+add_vrcx_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + add_vrcx_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+add_vrcx_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vrcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "dhcp_dns" : dhcp_dns, @@ -3889,19 +5141,24 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vrcx2 + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_vrcx2 ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vrcx2(self, - local_dev=None, - nexthop6=None, - resource=None, - shelf=None, - subnets6=None, - vr_name=None, + local_dev=None, + nexthop6=None, + resource=None, + shelf=None, + subnets6=None, + vr_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_vrcx2(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "local_dev" : local_dev, @@ -3920,12 +5177,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_vsta + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_sta ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class add_sta_flags(Enum): + class add_sta_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -3965,22 +5225,53 @@ class LFJsonPost(LFCliBase): 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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + 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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - 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 @@ -3998,6 +5289,11 @@ class LFJsonPost(LFCliBase): 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 @@ -4006,29 +5302,34 @@ class LFJsonPost(LFCliBase): 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, + 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, @@ -4063,54 +5364,64 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/add_wl_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#add_wl_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class add_wl_endp_wle_flags(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_add_wl_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -4160,18 +5471,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/admin + Notes for type requests https://www.candelatech.com/lfcli_ug.php#admin ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_admin(self, - arg1=None, - arg2=None, - arg3=None, - arg5=None, - cmd=None, + arg1=None, + arg2=None, + arg3=None, + arg5=None, + cmd=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_admin(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "arg1" : arg1, @@ -4189,15 +5505,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/apply_vr_cfg + Notes for type requests https://www.candelatech.com/lfcli_ug.php#apply_vr_cfg ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_apply_vr_cfg(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_apply_vr_cfg(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -4212,16 +5533,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/blink_attenuator + Notes for type requests https://www.candelatech.com/lfcli_ug.php#blink_attenuator ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_blink_attenuator(self, - resource=None, - serno=None, - shelf=None, + resource=None, + serno=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_blink_attenuator(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -4237,12 +5563,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/c_show_ports + Notes for type requests https://www.candelatech.com/lfcli_ug.php#c_show_ports ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class c_show_ports_probe_flags(Enum): + class c_show_ports_probe_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -4254,28 +5583,59 @@ class LFJsonPost(LFCliBase): MII = 0x2 # 2 include MII WIFI = 0x1 # 1 include wifi stations + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + c_show_ports_probe_flags.add_flags('bridge', 'dhcp') + print('value now: '+c_show_ports_probe_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + c_show_ports_probe_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+c_show_ports_probe_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_c_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, + probe_flags=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_c_show_ports(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -4292,15 +5652,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/cancel_vr_cfg + Notes for type requests https://www.candelatech.com/lfcli_ug.php#cancel_vr_cfg ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_cancel_vr_cfg(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_cancel_vr_cfg(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -4315,15 +5680,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_card_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_resource_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_card_counters(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_card_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -4338,14 +5708,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_cd_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_cd_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cd_counters(self, - cd_name=None, + cd_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_cd_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd_name" : cd_name, @@ -4359,14 +5734,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_cx_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_cx_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cx_counters(self, - cx_name=None, + cx_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_cx_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -4380,16 +5760,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_endp_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_endp_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_endp_counters(self, - endp_name=None, - incr_seqno=None, - just_latency=None, + endp_name=None, + incr_seqno=None, + just_latency=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_endp_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -4405,14 +5790,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_group(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -4426,23 +5816,33 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_port_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_port_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class clear_port_counters_extra(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 dhcp6_lease = "dhcp6_lease" # Remove dhcp lease files for IPv6 DHCP dhcp_leases = "dhcp_leases" # Remove dhcp lease files for IPv4 and IPv6 DHCP def post_clear_port_counters(self, - extra=None, - port=None, - resource=None, - shelf=None, + extra=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_port_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "extra" : extra, @@ -4459,15 +5859,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_resource_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_resource_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_resource_counters(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_resource_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -4482,15 +5887,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/clear_wp_counters + Notes for type requests https://www.candelatech.com/lfcli_ug.php#clear_wp_counters ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_wp_counters(self, - endp_name=None, - wp_name=None, + endp_name=None, + wp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_clear_wp_counters(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -4505,16 +5915,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/create_client + Notes for type requests https://www.candelatech.com/lfcli_ug.php#create_client ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_create_client(self, - name=None, - password=None, - super_user=None, + name=None, + password=None, + super_user=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_create_client(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -4530,15 +5945,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/diag + Notes for type requests https://www.candelatech.com/lfcli_ug.php#diag ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_diag(self, - arg1=None, - type=None, + arg1=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_diag(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "arg1" : arg1, @@ -4553,16 +5973,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/discover + Notes for type requests https://www.candelatech.com/lfcli_ug.php#discover ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_discover(self, - disconnect=None, - resource=None, - shelf=None, + disconnect=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_discover(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "disconnect" : disconnect, @@ -4578,15 +6003,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/do_pesq + Notes for type requests https://www.candelatech.com/lfcli_ug.php#do_pesq ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_do_pesq(self, - endp_name=None, - result_file_name=None, + endp_name=None, + result_file_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_do_pesq(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -4601,13 +6031,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/exit + 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 = { } @@ -4620,17 +6055,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/file + Notes for type requests https://www.candelatech.com/lfcli_ug.php#file ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_file(self, - card=None, - cmd=None, - filename=None, - shelf=None, + card=None, + cmd=None, + filename=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_file(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "card" : card, @@ -4647,17 +6087,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/flash_attenuator + Notes for type requests https://www.candelatech.com/lfcli_ug.php#flash_attenuator ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_flash_attenuator(self, - filename=None, - resource=None, - serno=None, - shelf=None, + filename=None, + resource=None, + serno=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_flash_attenuator(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "filename" : filename, @@ -4674,15 +6119,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getavglatency + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getavglatency ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getavglatency(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getavglatency(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4697,15 +6147,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getinrxbps + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getinrxbps ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxbps(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getinrxbps(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4720,15 +6175,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getinrxrate + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getinrxrate ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxrate(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getinrxrate(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4743,15 +6203,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getintxrate + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getintxrate ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getintxrate(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getintxrate(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4766,15 +6231,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getipadd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getipadd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getipadd(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getipadd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4789,15 +6259,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getmac + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getmac ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmac(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getmac(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4812,15 +6287,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getmask + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getmask ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmask(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getmask(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4835,15 +6315,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getpktdrops + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getpktdrops ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getpktdrops(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getpktdrops(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4858,15 +6343,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getrxendperrpkts + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getrxendperrpkts ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxendperrpkts(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getrxendperrpkts(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4881,15 +6371,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getrxpkts + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getrxpkts ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxpkts(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getrxpkts(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4904,15 +6399,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/getrxporterrpkts + Notes for type requests https://www.candelatech.com/lfcli_ug.php#getrxporterrpkts ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxporterrpkts(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_getrxporterrpkts(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4927,15 +6427,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/gettxpkts + Notes for type requests https://www.candelatech.com/lfcli_ug.php#gettxpkts ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gettxpkts(self, - aorb=None, - cx=None, + aorb=None, + cx=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_gettxpkts(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "aorb" : aorb, @@ -4950,14 +6455,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/gossip + Notes for type requests https://www.candelatech.com/lfcli_ug.php#gossip ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gossip(self, - message=None, + message=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_gossip(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "message" : message, @@ -4971,14 +6481,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/help + Notes for type requests https://www.candelatech.com/lfcli_ug.php#help ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_help(self, - command=None, + command=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_help(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "command" : command, @@ -4992,17 +6507,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/init_wiser + Notes for type requests https://www.candelatech.com/lfcli_ug.php#init_wiser ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_init_wiser(self, - file_name=None, - node_count=None, - resource=None, - shelf=None, + file_name=None, + node_count=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_init_wiser(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "file_name" : file_name, @@ -5019,15 +6539,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/licenses + Notes for type requests https://www.candelatech.com/lfcli_ug.php#licenses ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_licenses(self, - popup=None, - show_file=None, + popup=None, + show_file=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_licenses(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "popup" : popup, @@ -5042,18 +6567,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/load + Notes for type requests https://www.candelatech.com/lfcli_ug.php#load ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_load(self, - action=None, - clean_chambers=None, - clean_dut=None, - clean_profiles=None, - name=None, + action=None, + clean_chambers=None, + clean_dut=None, + clean_profiles=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_load(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "action" : action, @@ -5071,12 +6601,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/log_level + Notes for type requests https://www.candelatech.com/lfcli_ug.php#log_level ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class log_level_level(Enum): + class log_level_level(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -5098,26 +6631,57 @@ class LFJsonPost(LFCliBase): WRN = 0x4 # warnings (4) XMT = 0x100 # Output going to clients (256) + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + log_level_level.add_flags('bridge', 'dhcp') + print('value now: '+log_level_level.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + log_level_level.clear_flags('bridge', 'dhcp') + print( 'value now: '+log_level_level.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_log_level(self, - level=None, - target=None, + level=None, + target=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_log_level(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "level" : level, @@ -5132,14 +6696,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/log_msg + Notes for type requests https://www.candelatech.com/lfcli_ug.php#log_msg ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_log_msg(self, - message=None, + message=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_log_msg(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "message" : message, @@ -5153,15 +6722,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/login + Notes for type requests https://www.candelatech.com/lfcli_ug.php#login ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_login(self, - name=None, - password=None, + name=None, + password=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_login(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -5176,13 +6750,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/logout + 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 = { } @@ -5195,13 +6774,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/motd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#motd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_motd(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_motd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -5214,16 +6798,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_cd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_cd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_cd(self, - collision_domain=None, - resource=None, - shelf=None, + collision_domain=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_cd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "collision_domain" : collision_domain, @@ -5239,16 +6828,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_channel_groups + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_channel_groups ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_channel_groups(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_channel_groups(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "channel_name" : channel_name, @@ -5264,15 +6858,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_endpoints + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_endpoints ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_endpoints(self, - endpoint=None, - extra=None, + endpoint=None, + extra=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_endpoints(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -5287,14 +6886,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_pesq + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_pesq ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_pesq(self, - endpoint=None, + endpoint=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_pesq(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -5308,12 +6912,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_ports + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_ports ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class nc_show_ports_probe_flags(Enum): + class nc_show_ports_probe_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -5325,28 +6932,59 @@ class LFJsonPost(LFCliBase): MII = 0x2 # 2 include MII WIFI = 0x1 # 1 include wifi stations + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + nc_show_ports_probe_flags.add_flags('bridge', 'dhcp') + print('value now: '+nc_show_ports_probe_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + nc_show_ports_probe_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+nc_show_ports_probe_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_nc_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, + probe_flags=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_ports(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -5363,16 +7001,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_ppp_links + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_ppp_links ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_ppp_links(self, - link_num=None, - resource=None, - shelf=None, + link_num=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_ppp_links(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "link_num" : link_num, @@ -5388,16 +7031,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_spans + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_spans ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_spans(self, - resource=None, - shelf=None, - span_number=None, + resource=None, + shelf=None, + span_number=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_spans(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5413,16 +7061,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vr(self, - resource=None, - router=None, - shelf=None, + resource=None, + router=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5438,16 +7091,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/nc_show_vrcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#nc_show_vrcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vrcx(self, - cx_name=None, - resource=None, - shelf=None, + cx_name=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_nc_show_vrcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -5463,22 +7121,27 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/notify_dhcp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#notify_dhcp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + netmask=None, + new_dns=None, + new_ip=None, + new_ip6=None, + new_mtu=None, + new_router=None, + port=None, + reason=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_notify_dhcp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cmd" : cmd, @@ -5500,16 +7163,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/port_reset_completed + Notes for type requests https://www.candelatech.com/lfcli_ug.php#port_reset_completed ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_port_reset_completed(self, - extra=None, - port=None, - type=None, + extra=None, + port=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_port_reset_completed(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "extra" : extra, @@ -5525,17 +7193,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/probe_port + Notes for type requests https://www.candelatech.com/lfcli_ug.php#probe_port ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_port(self, - key=None, - port=None, - resource=None, - shelf=None, + key=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_probe_port(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "key" : key, @@ -5552,15 +7225,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/probe_ports + Notes for type requests https://www.candelatech.com/lfcli_ug.php#probe_ports ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_ports(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_probe_ports(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5575,14 +7253,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/quiesce_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#quiesce_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_endp(self, - endp_name=None, + endp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_quiesce_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -5596,14 +7279,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/quiesce_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#quiesce_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_group(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_quiesce_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -5617,13 +7305,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/quit + Notes for type requests https://www.candelatech.com/lfcli_ug.php#quit ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quit(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_quit(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -5636,15 +7329,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/reboot_os + Notes for type requests https://www.candelatech.com/lfcli_ug.php#reboot_os ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reboot_os(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_reboot_os(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5659,18 +7357,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/report + Notes for type requests https://www.candelatech.com/lfcli_ug.php#report ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_report(self, - reporting_on=None, - rpt_dir=None, - save_endps=None, - save_ports=None, - save_resource=None, + reporting_on=None, + rpt_dir=None, + save_endps=None, + save_ports=None, + save_resource=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_report(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "reporting_on" : reporting_on, @@ -5688,24 +7391,34 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/reset_port + Notes for type requests https://www.candelatech.com/lfcli_ug.php#reset_port ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class reset_port_pre_ifdown(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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) P_OUT = "P-OUT" # Only call the portal logout (do not reset drivers/supplicant/dhcp) YES = "YES" # (include logout) Call portal-bot.pl ... --logout before going down. def post_reset_port(self, - port=None, - pre_ifdown=None, - reset_ospf=None, - resource=None, - shelf=None, + port=None, + pre_ifdown=None, + reset_ospf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_reset_port(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -5723,16 +7436,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/reset_serial_span + Notes for type requests https://www.candelatech.com/lfcli_ug.php#reset_serial_span ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reset_serial_span(self, - resource=None, - shelf=None, - span=None, + resource=None, + shelf=None, + span=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_reset_serial_span(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5748,16 +7466,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_attenuator + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_attenuator ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_attenuator(self, - resource=None, - serno=None, - shelf=None, + resource=None, + serno=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_attenuator(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -5773,14 +7496,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_cd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_cd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd(self, - cd=None, + cd=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_cd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd" : cd, @@ -5794,15 +7522,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_cd_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_cd_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_endp(self, - cd=None, - endp=None, + cd=None, + endp=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_cd_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd" : cd, @@ -5817,15 +7550,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_cd_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_cd_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_vr(self, - cd=None, - endp=None, + cd=None, + endp=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_cd_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cd" : cd, @@ -5840,14 +7578,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_chamber + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_chamber ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber(self, - chamber=None, + chamber=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_chamber(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chamber" : chamber, @@ -5861,15 +7604,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_chamber_path + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_chamber_path ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber_path(self, - chamber=None, - path=None, + chamber=None, + path=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_chamber_path(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chamber" : chamber, @@ -5884,16 +7632,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_channel_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_channel_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_channel_group(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_channel_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "channel_name" : channel_name, @@ -5909,15 +7662,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_client + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_client ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_client(self, - client_name=None, - client_password=None, + client_name=None, + client_password=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_client(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "client_name" : client_name, @@ -5932,15 +7690,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_cx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_cx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cx(self, - cx_name=None, - test_mgr=None, + cx_name=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_cx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -5955,14 +7718,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_db + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_db ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_db(self, - db_name=None, + db_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_db(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "db_name" : db_name, @@ -5976,14 +7744,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_dut + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_dut ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_dut(self, - shelf=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_dut(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "shelf" : shelf, @@ -5997,14 +7770,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_endp(self, - endp_name=None, + endp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -6018,14 +7796,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_event + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_event ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_event(self, - event_id=None, + event_id=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_event(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "event_id" : event_id, @@ -6039,14 +7822,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_group(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -6060,16 +7848,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_ppp_link + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_ppp_link ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, + shelf=None, + unit_num=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_ppp_link(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6085,14 +7878,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_profile(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -6106,15 +7904,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_resource + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_resource ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_resource(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_resource(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6129,15 +7932,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_rfgen + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_rfgen ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_rfgen(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_rfgen(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6152,17 +7960,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_sec_ip + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_sec_ip ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_sec_ip(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ip_list" : ip_list, @@ -6179,16 +7992,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_span + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_span ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_span(self, - resource=None, - shelf=None, - span_num=None, + resource=None, + shelf=None, + span_num=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_span(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6204,14 +8022,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_test_mgr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_test_mgr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_test_mgr(self, - test_mgr=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_test_mgr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "test_mgr" : test_mgr, @@ -6225,15 +8048,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_text_blob + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_text_blob ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_text_blob(self, - name=None, - type=None, + name=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_text_blob(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -6248,15 +8076,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_tgcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_tgcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_tgcx(self, - cxname=None, - tgname=None, + cxname=None, + tgname=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_tgcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cxname" : cxname, @@ -6271,15 +8104,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_threshold + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_threshold ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_threshold(self, - endp=None, - thresh_id=None, + endp=None, + thresh_id=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_threshold(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp" : endp, @@ -6294,14 +8132,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_traffic_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_traffic_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_traffic_profile(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_traffic_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -6315,16 +8158,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_venue + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_venue ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_venue(self, - resource=None, - shelf=None, - venu_id=None, + resource=None, + shelf=None, + venu_id=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_venue(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6340,16 +8188,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_vlan + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_vlan ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vlan(self, - port=None, - resource=None, - shelf=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_vlan(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -6365,16 +8218,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vr(self, - resource=None, - router_name=None, - shelf=None, + resource=None, + router_name=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -6390,18 +8248,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_vrcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_vrcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vrcx(self, - connection_name=None, - resource=None, - shelf=None, - vr_id=None, - vrcx_only=None, + connection_name=None, + resource=None, + shelf=None, + vr_id=None, + vrcx_only=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_vrcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "connection_name" : connection_name, @@ -6419,15 +8282,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rm_wanpath + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rm_wanpath ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_wanpath(self, - endp_name=None, - wp_name=None, + endp_name=None, + wp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rm_wanpath(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -6442,20 +8310,25 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/rpt_script + Notes for type requests https://www.candelatech.com/lfcli_ug.php#rpt_script ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rpt_script(self, - endp=None, - flags=None, - group_action=None, - loop_count=None, - name=None, - private=None, - type=None, + endp=None, + flags=None, + group_action=None, + loop_count=None, + name=None, + private=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_rpt_script(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp" : endp, @@ -6475,14 +8348,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/save + Notes for type requests https://www.candelatech.com/lfcli_ug.php#write ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_save(self, - db_name=None, + db_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_save(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "db_name" : db_name, @@ -6496,24 +8374,34 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/scan_wifi + Notes for type requests https://www.candelatech.com/lfcli_ug.php#scan_wifi ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class scan_wifi_extra(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 dump = "dump" # then only cached values are returned trigger_freq__freq_ = "trigger freq [freq]" # scan exactly those frequencies def post_scan_wifi(self, - extra=None, - key=None, - port=None, - resource=None, - shelf=None, + extra=None, + key=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_scan_wifi(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "extra" : extra, @@ -6531,12 +8419,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_arm_info + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_arm_info ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_arm_info_arm_flags(Enum): + class set_arm_info_arm_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -6547,43 +8438,74 @@ class LFJsonPost(LFCliBase): use_gw_mac = 0x1000 # Use default gateway's MAC for destination MAC. use_tcp = 0x8000 # Use TCP instead of UDP protocol. (Note this is NOT stateful TCP!) + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_arm_info_arm_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_arm_info_arm_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_arm_info_arm_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_arm_info_arm_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_arm_info(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "arm_flags" : arm_flags, @@ -6615,23 +8537,28 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_attenuator + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_attenuator ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_attenuator(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "atten_idx" : atten_idx, @@ -6654,19 +8581,24 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_chamber + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_chamber ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_chamber(self, - chamber=None, - cur_rotation=None, - position=None, - speed_rpm=None, - tilt=None, - turntable=None, + chamber=None, + cur_rotation=None, + position=None, + speed_rpm=None, + tilt=None, + turntable=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_chamber(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chamber" : chamber, @@ -6685,17 +8617,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_cx_report_timer + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_cx_report_timer ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_cx_report_timer(self, - cx_name=None, - cxonly=None, - milliseconds=None, - test_mgr=None, + cx_name=None, + cxonly=None, + milliseconds=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_cx_report_timer(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -6712,12 +8649,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_cx_state + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_cx_state ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_cx_state_cx_state(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_cx_state_cx_state.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_cx_state_cx_state.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" DELETED = "DELETED" # Deletes the CX(s). QUIESCE = "QUIESCE" # Stop transmitting and gracefully stop cross-connect. RUNNING = "RUNNING" # Sets the CX(s) in the running state. @@ -6726,10 +8668,15 @@ class LFJsonPost(LFCliBase): def post_set_cx_state(self, - cx_name=None, - cx_state=None, - test_mgr=None, + cx_name=None, + cx_state=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_cx_state(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -6745,18 +8692,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_addr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_addr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_addr(self, - ip=None, - mac=None, - max_port=None, - min_port=None, - name=None, + ip=None, + mac=None, + max_port=None, + min_port=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_addr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ip" : ip, @@ -6774,30 +8726,35 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_details + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_details ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_details(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "conn_timeout" : conn_timeout, @@ -6827,16 +8784,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_file + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_file ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_file(self, - file=None, - name=None, - playback=None, + file=None, + name=None, + playback=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_file(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "file" : file, @@ -6852,12 +8814,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_flag + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_flag ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_endp_flag_flag(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_endp_flag_flag.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_endp_flag_flag.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" AutoHelper = "AutoHelper" # Automatically run on helper process ClearPortOnStart = "ClearPortOnStart" # clear stats on start DoChecksum = "DoChecksum" # Enable checksumming @@ -6873,10 +8840,15 @@ class LFJsonPost(LFCliBase): def post_set_endp_flag(self, - flag=None, - name=None, - val=None, + flag=None, + name=None, + val=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_flag(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "flag" : flag, @@ -6892,12 +8864,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_payload + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_payload ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_endp_payload_payload_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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) PRBS_15_0_14 = "PRBS_15_0_14" # PRBS (see above) PRBS_4_0_3 = "PRBS_4_0_3" # Use linear feedback shift register to generate pseudo random sequence. @@ -6912,10 +8889,15 @@ class LFJsonPost(LFCliBase): def post_set_endp_payload(self, - name=None, - payload=None, - payload_type=None, + name=None, + payload=None, + payload_type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_payload(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -6931,18 +8913,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_pld_bounds + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_pld_bounds ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + max_pld_size=None, + min_pld_size=None, + name=None, + use_checksum=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_pld_bounds(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "is_random" : is_random, @@ -6960,17 +8947,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_proxy + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_proxy ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_proxy(self, - enabled=None, - endp_name=None, - proxy_ip=None, - proxy_ip_port=None, + enabled=None, + endp_name=None, + proxy_ip=None, + proxy_ip_port=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_proxy(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "enabled" : enabled, @@ -6987,15 +8979,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_quiesce + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_quiesce ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_quiesce(self, - name=None, - quiesce=None, + name=None, + quiesce=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_quiesce(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -7010,15 +9007,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_report_timer + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_report_timer ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_report_timer(self, - endp_name=None, - milliseconds=None, + endp_name=None, + milliseconds=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_report_timer(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -7033,12 +9035,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_tos + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_tos ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_endp_tos_tos(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_endp_tos_tos.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_endp_tos_tos.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" LOWCOST = "LOWCOST" LOWDELAY = "LOWDELAY" RELIABILITY = "RELIABILITY" @@ -7046,10 +9053,15 @@ class LFJsonPost(LFCliBase): def post_set_endp_tos(self, - name=None, - priority=None, - tos=None, + name=None, + priority=None, + tos=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_tos(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -7065,17 +9077,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_endp_tx_bounds + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_endp_tx_bounds ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_tx_bounds(self, - is_bursty=None, - max_tx_rate=None, - min_tx_rate=None, - name=None, + is_bursty=None, + max_tx_rate=None, + min_tx_rate=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_endp_tx_bounds(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "is_bursty" : is_bursty, @@ -7092,34 +9109,66 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_event_interest + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_event_interest ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_event_interest_ei_flags(Enum): + class set_event_interest_ei_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 CLEAR = 0x0 # will clear interest SET = 0x1 # set interest flag + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_ei_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_event_interest_ei_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_ei_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_event_interest_ei_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 set_event_interest_events1(Enum): + class set_event_interest_events1(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7156,22 +9205,51 @@ class LFJsonPost(LFCliBase): TX_BPS_OOR_3S = 0x80000000 # Endpoint threshold alert. WiFi_Config = 0x80000 # WiFi Configuration Error. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_events1.add_flags('bridge', 'dhcp') + print('value now: '+set_event_interest_events1.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_events1.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_event_interest_events1.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 set_event_interest_events2(Enum): + class set_event_interest_events2(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7193,31 +9271,62 @@ class LFJsonPost(LFCliBase): TX_BPS_OOR_30S_CLEARED = 0x4 # Endpoint threshold alert cleared. TX_BPS_OOR_3S_CLEARED = 0x1 # Endpoint threshold alert cleared. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_events2.add_flags('bridge', 'dhcp') + print('value now: '+set_event_interest_events2.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_interest_events2.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_event_interest_events2.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_event_interest(self, - ei_flags=None, - event_cnt=None, - events1=None, - events2=None, - events3=None, - events4=None, - var1=None, + ei_flags=None, + event_cnt=None, + events1=None, + events2=None, + events3=None, + events4=None, + var1=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_event_interest(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ei_flags" : ei_flags, @@ -7237,12 +9346,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_event_priority + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_event_priority ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_event_priority_event(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_priority_event.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_event_priority_event.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" Bad_MAC = 20 # Invalid MAC address configured. Cleared = 13 # Counters were cleared for some entity. Connect = 8 # WiFi interface connected to AP. @@ -7267,6 +9381,11 @@ class LFJsonPost(LFCliBase): WiFi_Config = 19 # WiFi Configuration Error. class set_event_priority_priority(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_event_priority_priority.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_event_priority_priority.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" AUTO = "AUTO" # Let event creator decide the priority. CRITICAL = "CRITICAL" DEBUG = "DEBUG" @@ -7276,9 +9395,14 @@ class LFJsonPost(LFCliBase): def post_set_event_priority(self, - event=None, - priority=None, + event=None, + priority=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_event_priority(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "event" : event, @@ -7293,23 +9417,28 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_fe_info + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_fe_info ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_fe_info(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "directory" : directory, @@ -7332,12 +9461,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_flag + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_flag ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_flag_flag(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_flag_flag.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_flag_flag.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" brief = "brief" # Request more abbreviated output to various commands. prompt_newlines = "prompt_newlines" # Add a newline after every prompt. Can help with scripts push_all_rpts = "push_all_rpts" # If enabled, server will send port, endpoint, and other @@ -7347,10 +9481,15 @@ class LFJsonPost(LFCliBase): def post_set_flag(self, - client=None, - flag=None, - val=None, + client=None, + flag=None, + val=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_flag(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "client" : client, @@ -7366,15 +9505,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_gen_cmd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_gen_cmd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gen_cmd(self, - command=None, - name=None, + command=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_gen_cmd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "command" : command, @@ -7389,20 +9533,25 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_gps_info + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_gps_info ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gps_info(self, - altitude=None, - ew=None, - lattitude=None, - longitude=None, - ns=None, - resource=None, - shelf=None, + altitude=None, + ew=None, + lattitude=None, + longitude=None, + ns=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_gps_info(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "altitude" : altitude, @@ -7422,18 +9571,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_ifup_script + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_ifup_script ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ifup_script(self, - flags=None, - port=None, - post_ifup_script=None, - resource=None, - shelf=None, + flags=None, + port=None, + post_ifup_script=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_ifup_script(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "flags" : flags, @@ -7451,14 +9605,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_license + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_license ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_license(self, - licenses=None, + licenses=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_license(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "licenses" : licenses, @@ -7472,18 +9631,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_mc_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_mc_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_mc_endp(self, - mcast_dest_port=None, - mcast_group=None, - name=None, - rcv_mcast=None, - ttl=None, + mcast_dest_port=None, + mcast_group=None, + name=None, + rcv_mcast=None, + ttl=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_mc_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "mcast_dest_port" : mcast_dest_port, @@ -7501,16 +9665,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_password + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_password ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_password(self, - client=None, - new_password=None, - old_password=None, + client=None, + new_password=None, + old_password=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_password(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "client" : client, @@ -7526,14 +9695,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_poll_mode + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_poll_mode ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_poll_mode(self, - mode=None, + mode=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_poll_mode(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "mode" : mode, @@ -7547,12 +9721,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_port + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_port ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_port_cmd_flags(Enum): + class set_port_cmd_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7569,22 +9746,51 @@ class LFJsonPost(LFCliBase): skip_port_bounce = 0x100 # skip-port-bounce (Don't ifdown/up use_pre_ifdown = 0x800 # Call pre-ifdown script before bringing interface down. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_cmd_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_port_cmd_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_cmd_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_port_cmd_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 set_port_current_flags(Enum): + class set_port_current_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7624,22 +9830,53 @@ class LFJsonPost(LFCliBase): use_dhcp = 0x80000000 # USE-DHCP use_dhcpv6 = 0x20000000000 # USE-DHCPv6 + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_current_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_port_current_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_current_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_port_current_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 set_port_dhcp_client_id(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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. NONE = "NONE" # Do not use dhcp client ID. p_string_ = "[string]" # Use the string for the client ID. @@ -7647,6 +9884,11 @@ class LFJsonPost(LFCliBase): p__MAC = "__MAC" # Use interface's MAC address for the client ID. class set_port_dhcp_hostname(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_dhcp_hostname.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_port_dhcp_hostname.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NA = "NA" # Do not change from current value. NONE = "NONE" # Do not use dhcp Hostname p_string_ = "[string]" # Use the string for the Hostname. @@ -7654,11 +9896,19 @@ class LFJsonPost(LFCliBase): p__EID__ = "__EID__" # Use hostname 'CT-[resource-id].[port-name]' class set_port_dhcp_vendor_id(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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. NONE = "NONE" # Do not use dhcp vendor ID p_string_ = "[string]" # Use the string for the vendor ID. - class set_port_flags2(Enum): + class set_port_flags2(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7669,22 +9919,51 @@ class LFJsonPost(LFCliBase): supports_bypass = 0x2 # Support Bypass Devices use_stp = 0x1 # Use Spanning Tree Protocol + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_flags2.add_flags('bridge', 'dhcp') + print('value now: '+set_port_flags2.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_flags2.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_port_flags2.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 set_port_interest(Enum): + class set_port_interest(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -7722,61 +10001,92 @@ class LFJsonPost(LFCliBase): svc_httpd = 0x8000000 # Enable/disable HTTP Service for a port tx_queue_length = 0x200 # TX Queue Length + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_interest.add_flags('bridge', 'dhcp') + print('value now: '+set_port_interest.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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_port_interest.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_port_interest.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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_port(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -7826,18 +10136,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_port_alias + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_port_alias ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_port_alias(self, - alias=None, - port=None, - resource=None, - shelf=None, - vport=None, + alias=None, + port=None, + resource=None, + shelf=None, + vport=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_port_alias(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "alias" : alias, @@ -7855,17 +10170,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_ppp_link_state + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_ppp_link_state ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ppp_link_state(self, - link=None, - ppp_state=None, - resource=None, - shelf=None, + link=None, + ppp_state=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_ppp_link_state(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "link" : link, @@ -7882,28 +10202,38 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_resource + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_resource ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_resource_resource_flags(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_resource(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "device_profiles" : device_profiles, @@ -7927,49 +10257,83 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_rfgen + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_rfgen ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_rfgen_rfgen_flags(Enum): + class set_rfgen_rfgen_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 one_burst = 0x8 # Run for about 1 second and stop. Uses 5-sec sweep time for single pulse train. running = 0x2 # Should we start the RF Generator or not? + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_rfgen_rfgen_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_rfgen_rfgen_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_rfgen_rfgen_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_rfgen_rfgen_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_rfgen(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "bb_gain" : bb_gain, @@ -7995,12 +10359,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_script + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_script ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_script_flags(Enum): + class set_script_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8023,22 +10390,53 @@ class LFJsonPost(LFCliBase): SCR_SYMMETRIC = 0x4 # This script should apply settings to the peer endpoing as well. SCR_USE_MSS = 0x8000 # When setting packet size, set TCP MSS instead if endpoint supports that. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_script_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_script_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_script_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_script_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 set_script_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_script_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_script_type.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" NONE = "NONE" # Delete any existing script. Script2544 = "Script2544" # For RFC 2544 type testing. ScriptAtten = "ScriptAtten" # For Attenuators only. @@ -8047,14 +10445,19 @@ 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, + flags=None, + group_action=None, + loop_count=None, + name=None, + private=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_script(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp" : endp, @@ -8074,17 +10477,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_sec_ip + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_sec_ip ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_sec_ip(self, - ip_list=None, - port=None, - resource=None, - shelf=None, + ip_list=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_sec_ip(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "ip_list" : ip_list, @@ -8101,31 +10509,36 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_voip_info + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_voip_info ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_voip_info(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "codec" : codec, @@ -8156,22 +10569,27 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_vrcx_cost + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_vrcx_cost ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + local_dev=None, + local_dev_b=None, + remote_dev=None, + remote_dev_b=None, + resource=None, + shelf=None, + vr_name=None, + wanlink=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_vrcx_cost(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "interface_cost" : interface_cost, @@ -8193,28 +10611,33 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wanlink_info + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wanlink_info ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wanlink_info(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "drop_freq" : drop_freq, @@ -8242,16 +10665,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wanlink_pcap + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wanlink_pcap ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanlink_pcap(self, - capture=None, - directory=None, - name=None, + capture=None, + directory=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wanlink_pcap(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "capture" : capture, @@ -8267,12 +10695,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wanpath_corruption + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wanpath_corruption ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_wanpath_corruption_flags(Enum): + class set_wanpath_corruption_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8283,32 +10714,63 @@ class LFJsonPost(LFCliBase): 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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + 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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - 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_wanpath_corruption(self, - byte=None, - flags=None, - index=None, - max_offset=None, - min_offset=None, - name=None, - path=None, - rate=None, + 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_wanpath_corruption(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "byte" : byte, @@ -8329,21 +10791,26 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wanpath_filter + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wanpath_filter ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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_wanpath_filter(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "defer_flush" : defer_flush, @@ -8364,22 +10831,32 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wanpath_running + 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_wanpath_running(self, - running=None, - wl_name=None, - wp_name=None, + running=None, + wl_name=None, + wp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wanpath_running(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "running" : running, @@ -8395,12 +10872,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_corruptions + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_corruptions ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_wifi_corruptions_corrupt_flags(Enum): + class set_wifi_corruptions_corrupt_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8419,37 +10899,68 @@ class LFJsonPost(LFCliBase): MST_TYPE_EAPOL_OTHER_REQ = 0x1000 # EAP Requests that do not match other things. MST_TYPE_EAPOL_OTHER_RESP = 0x2000 # EAP Responses that do not match other things. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wifi_corruptions_corrupt_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_wifi_corruptions_corrupt_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wifi_corruptions_corrupt_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_wifi_corruptions_corrupt_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_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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_corruptions(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "corrupt_flags" : corrupt_flags, @@ -8475,18 +10986,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_custom + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_custom ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_custom(self, - port=None, - resource=None, - shelf=None, - text=None, - type=None, + port=None, + resource=None, + shelf=None, + text=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_custom(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -8504,45 +11020,50 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_extra + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_extra ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_extra(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "anonymous_identity" : anonymous_identity, @@ -8587,29 +11108,34 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_extra2 + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_extra2 ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_extra2(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "corrupt_gtk_rekey_mic" : corrupt_gtk_rekey_mic, @@ -8638,12 +11164,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_radio + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_radio ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_wifi_radio_flags(Enum): + class set_wifi_radio_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8656,22 +11185,53 @@ class LFJsonPost(LFCliBase): use_syslog = 0x20000000 # Put supplicant logs in syslog instead of a file. verbose = 0x10000 # Verbose-Debug: Increase debug info in wpa-supplicant and hostapd logs. + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wifi_radio_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_wifi_radio_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wifi_radio_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_wifi_radio_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 set_wifi_radio_mode(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 abg = 4 # 802.11abg @@ -8690,40 +11250,45 @@ 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_radio(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "active_peer_count" : active_peer_count, @@ -8769,24 +11334,29 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wifi_txo + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wifi_txo ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" 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, + 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, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wifi_txo(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -8810,12 +11380,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wl_corruption + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wl_corruption ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_wl_corruption_flags(Enum): + class set_wl_corruption_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8826,31 +11399,62 @@ class LFJsonPost(LFCliBase): 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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wl_corruption_flags.add_flags('bridge', 'dhcp') + print('value now: '+set_wl_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + set_wl_corruption_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+set_wl_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_wl_corruption(self, - byte=None, - flags=None, - index=None, - max_offset=None, - min_offset=None, - name=None, - rate=None, + byte=None, + flags=None, + index=None, + max_offset=None, + min_offset=None, + name=None, + rate=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wl_corruption(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "byte" : byte, @@ -8870,20 +11474,30 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wl_qdisc + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wl_qdisc ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class set_wl_qdisc_qdisc(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + 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 WRR__queue_queue_____ = "WRR,[queue,queue,...]" # Weighted Round Robbin is also available def post_set_wl_qdisc(self, - name=None, - qdisc=None, + name=None, + qdisc=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_set_wl_qdisc(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -8898,12 +11512,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wp_corruption + Notes for type requests https://www.candelatech.com/lfcli_ug.php#set_wanpath_corruption ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class set_wanpath_corruption_flags(Enum): + class set_wanpath_corruption_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -8914,32 +11531,63 @@ class LFJsonPost(LFCliBase): 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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + 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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - 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, + 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, @@ -8960,21 +11608,26 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wp_filter + 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, + 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, @@ -8995,22 +11648,32 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/set_wp_running + 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, + 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, @@ -9026,12 +11689,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_alerts + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_alerts ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class show_alerts_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + show_alerts_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+show_alerts_type.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" All = "All" CX = "CX" Card = "Card" @@ -9047,13 +11715,18 @@ class LFJsonPost(LFCliBase): def post_show_alerts(self, - card=None, - endp=None, - extra=None, - port=None, - shelf=None, - type=None, + card=None, + endp=None, + extra=None, + port=None, + shelf=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_alerts(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "card" : card, @@ -9072,16 +11745,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_attenuators + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_attenuators ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_attenuators(self, - resource=None, - serno=None, - shelf=None, + resource=None, + serno=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_attenuators(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9097,15 +11775,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_cards + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_resources ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cards(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_cards(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9120,16 +11803,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_cd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_cd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cd(self, - collision_domain=None, - resource=None, - shelf=None, + collision_domain=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_cd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "collision_domain" : collision_domain, @@ -9145,14 +11833,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_chamber + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_chamber ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_chamber(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_chamber(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -9166,16 +11859,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_channel_groups + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_channel_groups ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_channel_groups(self, - channel_name=None, - resource=None, - shelf=None, + channel_name=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_channel_groups(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "channel_name" : channel_name, @@ -9191,13 +11889,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_clients + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_clients ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_clients(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_clients(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -9210,15 +11913,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_cx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_cx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cx(self, - cross_connect=None, - test_mgr=None, + cross_connect=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_cx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cross_connect" : cross_connect, @@ -9233,15 +11941,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_cxe + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_cxe ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cxe(self, - cross_connect=None, - test_mgr=None, + cross_connect=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_cxe(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cross_connect" : cross_connect, @@ -9256,13 +11969,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_dbs + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_dbs ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_dbs(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_dbs(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -9275,14 +11993,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_dut + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_dut ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_dut(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_dut(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -9296,15 +12019,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_endp_payload + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_endp_payload ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endp_payload(self, - max_bytes=None, - name=None, + max_bytes=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_endp_payload(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "max_bytes" : max_bytes, @@ -9319,15 +12047,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_endpoints + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_endpoints ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endpoints(self, - endpoint=None, - extra=None, + endpoint=None, + extra=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_endpoints(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -9342,14 +12075,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_err + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_err ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_err(self, - message=None, + message=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_err(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "message" : message, @@ -9363,13 +12101,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_event_interest + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_event_interest ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_event_interest(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_event_interest(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -9382,12 +12125,17 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_events + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_events ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" class show_events_type(Enum): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + show_events_type.clear_flags('bridge', 'dhcp') + print( 'value now: '+show_events_type.value()) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" All = "All" CX = "CX" Card = "Card" @@ -9403,13 +12151,18 @@ class LFJsonPost(LFCliBase): def post_show_events(self, - card=None, - endp=None, - extra=None, - port=None, - shelf=None, - type=None, + card=None, + endp=None, + extra=None, + port=None, + shelf=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_events(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "card" : card, @@ -9428,19 +12181,24 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_files + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_files ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_files(self, - dir_flags=None, - directory=None, - filter=None, - key=None, - resource=None, - shelf=None, + dir_flags=None, + directory=None, + filter=None, + key=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_files(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "dir_flags" : dir_flags, @@ -9459,14 +12217,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_group(self, - group=None, + group=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "group" : group, @@ -9480,14 +12243,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_pesq + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_pesq ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_pesq(self, - endpoint=None, + endpoint=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_pesq(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -9501,17 +12269,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_ports + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_ports ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ports(self, - port=None, - probe_flags=None, - resource=None, - shelf=None, + port=None, + probe_flags=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_ports(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -9528,16 +12301,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_ppp_links + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_ppp_links ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ppp_links(self, - link_num=None, - resource=None, - shelf=None, + link_num=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_ppp_links(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "link_num" : link_num, @@ -9553,14 +12331,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_profile(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -9574,15 +12357,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_resources + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_resources ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_resources(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_resources(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9597,15 +12385,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_rfgen + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_rfgen ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rfgen(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_rfgen(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9620,17 +12413,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_rt + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_rt ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rt(self, - key=None, - resource=None, - shelf=None, - virtual_router=None, + key=None, + resource=None, + shelf=None, + virtual_router=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_rt(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "key" : key, @@ -9647,15 +12445,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_script_results + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_script_results ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_script_results(self, - endpoint=None, - key=None, + endpoint=None, + key=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_script_results(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -9670,16 +12473,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_spans + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_spans ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_spans(self, - resource=None, - shelf=None, - span_number=None, + resource=None, + shelf=None, + span_number=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_spans(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9695,16 +12503,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_text_blob + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_text_blob ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_text_blob(self, - brief=None, - name=None, - type=None, + brief=None, + name=None, + type=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_text_blob(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "brief" : brief, @@ -9720,14 +12533,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_tm + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_tm ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_tm(self, - test_mgr=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_tm(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "test_mgr" : test_mgr, @@ -9741,14 +12559,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_traffic_profile + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_traffic_profile ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_traffic_profile(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_traffic_profile(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -9762,16 +12585,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_venue + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_venue ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_venue(self, - resource=None, - shelf=None, - venu_id=None, + resource=None, + shelf=None, + venu_id=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_venue(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9787,16 +12615,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_vr + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_vr ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vr(self, - resource=None, - router=None, - shelf=None, + resource=None, + router=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_vr(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9812,16 +12645,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_vrcx + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_vrcx ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vrcx(self, - cx_name=None, - resource=None, - shelf=None, + cx_name=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_vrcx(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cx_name" : cx_name, @@ -9837,15 +12675,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_wanpaths + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_wanpaths ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_wanpaths(self, - endpoint=None, - wanpath=None, + endpoint=None, + wanpath=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_wanpaths(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -9860,15 +12703,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/show_wps + Notes for type requests https://www.candelatech.com/lfcli_ug.php#show_wanpaths ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_wps(self, - endpoint=None, - wanpath=None, + endpoint=None, + wanpath=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_show_wps(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endpoint" : endpoint, @@ -9883,16 +12731,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/shutdown + Notes for type requests https://www.candelatech.com/lfcli_ug.php#shutdown ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown(self, - chdir=None, - really=None, - serverctl=None, + chdir=None, + really=None, + serverctl=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_shutdown(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "chdir" : chdir, @@ -9908,15 +12761,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/shutdown_card + Notes for type requests https://www.candelatech.com/lfcli_ug.php#shutdown_resource ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_card(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_shutdown_card(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9931,15 +12789,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/shutdown_os + Notes for type requests https://www.candelatech.com/lfcli_ug.php#shutdown_os ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_os(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_shutdown_os(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9954,15 +12817,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/shutdown_resource + Notes for type requests https://www.candelatech.com/lfcli_ug.php#shutdown_resource ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_resource(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_shutdown_resource(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -9977,12 +12845,15 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/sniff_port + Notes for type requests https://www.candelatech.com/lfcli_ug.php#sniff_port ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" - class sniff_port_flags(Enum): + class sniff_port_flags(IntFlag): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" selected_named_flag_map = {} temp_flag_value = 0x0 @@ -9991,31 +12862,62 @@ class LFJsonPost(LFCliBase): MATE_XTERM = 0x8 # Launch tshark/dumpcap in xterm TSHARK = 0x1 # Use command-line tshark instead of wireshark + # (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_flag(self, flag_name): - self.selected_named_flag_map.put(flag_name, 0) + def add_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + sniff_port_flags.add_flags('bridge', 'dhcp') + print('value now: '+sniff_port_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_flag(self, flag_name): - if self.selected_named_flag_map.contains(flag_name): - self.selected_named_flag_map.remove(flag_name) - self.update_flag_value() + def clear_flags(self, flag_names=[]): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + sniff_port_flags.clear_flags('bridge', 'dhcp') + print( 'value now: '+sniff_port_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_sniff_port(self, - display=None, - duration=None, - flags=None, - outfile=None, - port=None, - resource=None, - shelf=None, + display=None, + duration=None, + flags=None, + outfile=None, + port=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_sniff_port(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "display" : display, @@ -10035,14 +12937,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/start_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#start_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_endp(self, - endp_name=None, + endp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_start_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -10056,14 +12963,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/start_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#start_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_group(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_start_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -10077,16 +12989,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/start_ppp_link + Notes for type requests https://www.candelatech.com/lfcli_ug.php#start_ppp_link ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, + shelf=None, + unit_num=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_start_ppp_link(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -10102,14 +13019,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/stop_endp + Notes for type requests https://www.candelatech.com/lfcli_ug.php#stop_endp ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_endp(self, - endp_name=None, + endp_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_stop_endp(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "endp_name" : endp_name, @@ -10123,14 +13045,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/stop_group + Notes for type requests https://www.candelatech.com/lfcli_ug.php#stop_group ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_group(self, - name=None, + name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_stop_group(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "name" : name, @@ -10144,16 +13071,21 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/stop_ppp_link + Notes for type requests https://www.candelatech.com/lfcli_ug.php#stop_ppp_link ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_ppp_link(self, - resource=None, - shelf=None, - unit_num=None, + resource=None, + shelf=None, + unit_num=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_stop_ppp_link(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -10169,18 +13101,23 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/tail + Notes for type requests https://www.candelatech.com/lfcli_ug.php#tail ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tail(self, - cmd=None, - key=None, - message=None, - resource=None, - shelf=None, + cmd=None, + key=None, + message=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_tail(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "cmd" : cmd, @@ -10198,15 +13135,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/tm_register + Notes for type requests https://www.candelatech.com/lfcli_ug.php#tm_register ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_register(self, - client_name=None, - test_mgr=None, + client_name=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_tm_register(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "client_name" : client_name, @@ -10221,15 +13163,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/tm_unregister + Notes for type requests https://www.candelatech.com/lfcli_ug.php#tm_unregister ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_unregister(self, - client_name=None, - test_mgr=None, + client_name=None, + test_mgr=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_tm_unregister(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "client_name" : client_name, @@ -10244,13 +13191,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/version + Notes for type requests https://www.candelatech.com/lfcli_ug.php#version ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_version(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_version(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -10263,13 +13215,18 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/who + Notes for type requests https://www.candelatech.com/lfcli_ug.php#who ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_who(self, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_who(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { } @@ -10282,17 +13239,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/wifi_cli_cmd + Notes for type requests https://www.candelatech.com/lfcli_ug.php#wifi_cli_cmd ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_cli_cmd(self, - port=None, - resource=None, - shelf=None, - wpa_cli_cmd=None, + port=None, + resource=None, + shelf=None, + wpa_cli_cmd=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_wifi_cli_cmd(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "port" : port, @@ -10309,17 +13271,22 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/wifi_event + Notes for type requests https://www.candelatech.com/lfcli_ug.php#wifi_event ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_event(self, - device=None, - event=None, - msg=None, - status=None, + device=None, + event=None, + msg=None, + status=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_wifi_event(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "device" : device, @@ -10336,15 +13303,20 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/wiser_reset + Notes for type requests https://www.candelatech.com/lfcli_ug.php#wiser_reset ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wiser_reset(self, - resource=None, - shelf=None, + resource=None, + shelf=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_wiser_reset(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "resource" : resource, @@ -10359,14 +13331,19 @@ class LFJsonPost(LFCliBase): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated method for /cli-json/write + Notes for type requests https://www.candelatech.com/lfcli_ug.php#write ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_write(self, - db_name=None, + db_name=None, debug_=False): + """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- + Example Usage: + result = post_write(param=value ...) + pprint.pprint( result ) + ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" debug_ |= self.debug data = { "db_name" : db_name,