pySROS modules

• pysros - Model-driven SR OS interface
  • pysros.management - Connection and data handling
    • connect()
    • sros()
    • Connection
      • Connection.disconnect()
      • Connection.cli()
      • Connection.action()
      • Connection.convert()
      • Connection.list_paths()
      • Connection.session_id()
    • Datastore
      • Datastore.get()
      • Datastore.set()
      • Datastore.delete()
      • Datastore.exists()
      • Datastore.get_list_keys()
      • Datastore.lock()
      • Datastore.unlock()
      • Datastore.commit()
      • Datastore.discard()
      • Datastore.compare()
    • SrosMgmtError
    • InvalidPathError
    • ModelProcessingError
    • InternalError
    • SrosConfigConflictError
    • ActionTerminatedIncompleteError
    • JsonDecodeError
    • XmlDecodeError
    • Empty
  • pysros.pprint - Specialized output formatting
    • TreePrinter
      • TreePrinter.print()
    • printTree()
    • Column
      • Column.format()
      • Column.create()
    • Padding
    • Table
      • Table.print()
      • Table.printRows()
      • Table.printRow()
      • Table.printColumnHeaders()
      • Table.printSummary()
    • KeyValueTable
      • KeyValueTable.printKV()
      • KeyValueTable.printKVs()
      • KeyValueTable.print()
      • KeyValueTable.printColumnHeaders()
  • pysros.wrappers - Model-driven class wrappers
    • Action
    • Container
    • Leaf
    • LeafList
      • LeafList.annotations
    • Annotation
      • Annotation.key
      • Annotation.data
      • Annotation.module
      • Annotation.namespace
      • Annotation.schema
    • Annotations
      • Annotations.index_annotation()
      • Annotations.get()
      • Annotations.get_annotation()
      • Annotations.remove_annotation()
    • Schema
      • Schema.module
      • Schema.namespace
      • Schema.yang_type
      • Schema.units
      • Schema.default
      • Schema.mandatory
    • SchemaType
      • SchemaType.range
      • SchemaType.union_members
  • pysros.exceptions - pySROS specific exceptions
    • SrosMgmtError
    • InvalidPathError
    • ModelProcessingError
    • InternalError
    • SrosConfigConflictError
    • ActionTerminatedIncompleteError
    • JsonDecodeError
    • XmlDecodeError
  • pysros.ehs - Functions for the event handling system (EHS)
    • pysros.ehs.get_event()
    • pysros.ehs.Event
      • pysros.ehs.Event.name
      • pysros.ehs.Event.appid
      • pysros.ehs.Event.eventid
      • pysros.ehs.Event.severity
      • pysros.ehs.Event.sequence
      • pysros.ehs.Event.subject
      • pysros.ehs.Event.router_name
      • pysros.ehs.Event.gentime
      • pysros.ehs.Event.timestamp
      • pysros.ehs.Event.text
      • pysros.ehs.Event.eventparameters
      • pysros.ehs.Event.format_msg()
    • pysros.ehs.EventParams
      • pysros.ehs.EventParams.keys()
  • pysros.esm - Functions for the enhanced subscriber management system (ESM)
    • pysros.esm.get_event()
    • pysros.esm.Event
      • pysros.esm.Event.eventparameters
    • pysros.esm.EventParams
      • pysros.esm.EventParams.keys()
  • pysros.esm.cryptolib - Cryptographic functions for the ESM system
    • pysros.esm.cryptolib.AES
      • pysros.esm.cryptolib.AES.encrypt()
      • pysros.esm.cryptolib.AES.decrypt()
    • MODE_ECB
    • MODE_CBC
    • pysros.esm.cryptolib.pad()
    • pysros.esm.cryptolib.unpad()
  • pysros.syslog - Functions for syslog event handling
    • pysros.syslog.get_event()
    • generate_pri()
    • severity_to_name()
    • get_system_name()
    • pysros.syslog.Event
      • pysros.syslog.Event.name
      • pysros.syslog.Event.appid
      • pysros.syslog.Event.eventid
      • pysros.syslog.Event.severity
      • pysros.syslog.Event.sequence
      • pysros.syslog.Event.subject
      • pysros.syslog.Event.router_name
      • pysros.syslog.Event.gentime
      • pysros.syslog.Event.timestamp
      • pysros.syslog.Event.hostname
      • pysros.syslog.Event.log_prefix
      • pysros.syslog.Event.facility
      • pysros.syslog.Event.text
      • pysros.syslog.Event.eventparameters
      • pysros.syslog.Event.format_msg()
      • pysros.syslog.Event.format_syslog_msg()
      • pysros.syslog.Event.override_payload()
      • pysros.syslog.Event.drop()
    • pysros.syslog.EventParams
      • pysros.syslog.EventParams.keys()
    • pysros.syslog.Facility
      • pysros.syslog.Facility.KERNEL
      • pysros.syslog.Facility.USER
      • pysros.syslog.Facility.MAIL
      • pysros.syslog.Facility.SYSTEMD
      • pysros.syslog.Facility.AUTH
      • pysros.syslog.Facility.SYSLOGD
      • pysros.syslog.Facility.PRINTER
      • pysros.syslog.Facility.NETNEWS
      • pysros.syslog.Facility.UUCP
      • pysros.syslog.Facility.CRON
      • pysros.syslog.Facility.AUTHPRIV
      • pysros.syslog.Facility.FTP
      • pysros.syslog.Facility.NTP
      • pysros.syslog.Facility.LOGAUDIT
      • pysros.syslog.Facility.LOGALERT
      • pysros.syslog.Facility.CRON2
      • pysros.syslog.Facility.LOCAL0
      • pysros.syslog.Facility.LOCAL1
      • pysros.syslog.Facility.LOCAL2
      • pysros.syslog.Facility.LOCAL3
      • pysros.syslog.Facility.LOCAL4
      • pysros.syslog.Facility.LOCAL5
      • pysros.syslog.Facility.LOCAL6
      • pysros.syslog.Facility.LOCAL7

Libraries adapted for SR OS

The adapted versions of the modules documented here are provided when executing on SR OS only. When executing on a remote device, the native Python versions of the library are used.

• argparse – Argument parser functions
  • Core Functionality
  • Quick Links for add_argument()
  • Example
    • Creating a parser
    • Adding arguments
    • Parsing arguments
  • ArgumentParser objects
    • ArgumentParser
    • prog
    • usage
    • description
    • epilog
    • parents
    • formatter_class
      • RawDescriptionHelpFormatter
      • RawTextHelpFormatter
      • ArgumentDefaultsHelpFormatter
      • MetavarTypeHelpFormatter
    • prefix_chars
    • fromfile_prefix_chars
    • argument_default
    • allow_abbrev
    • conflict_handler
    • add_help
    • exit_on_error
  • The add_argument() method
    • ArgumentParser.add_argument()
    • name or flags
    • action
    • nargs
    • const
    • default
    • type
    • choices
    • required
    • help
    • metavar
    • dest
    • deprecated
    • Action classes
      • Action
  • The parse_args() method
    • ArgumentParser.parse_args()
    • Option value syntax
    • Invalid arguments
    • Arguments containing -
    • Argument abbreviations (prefix matching)
    • Beyond sys.argv
    • The Namespace object
      • Namespace
  • Other utilities
    • Sub-commands
      • ArgumentParser.add_subparsers()
    • Argument groups
      • ArgumentParser.add_argument_group()
    • Mutual exclusion
      • ArgumentParser.add_mutually_exclusive_group()
    • Parser defaults
      • ArgumentParser.set_defaults()
      • ArgumentParser.get_default()
    • Printing help
      • ArgumentParser.print_usage()
      • ArgumentParser.print_help()
      • ArgumentParser.format_usage()
      • ArgumentParser.format_help()
    • Partial parsing
      • ArgumentParser.parse_known_args()
    • Customizing file parsing
      • ArgumentParser.convert_arg_line_to_args()
    • Exiting methods
      • ArgumentParser.exit()
      • ArgumentParser.error()
    • Intermixed parsing
      • ArgumentParser.parse_intermixed_args()
      • ArgumentParser.parse_known_intermixed_args()
  • Exceptions
    • ArgumentError
    • ArgumentTypeError
• utime – Time functions
  • Functions
    • gmtime()
    • localtime()
    • mktime()
    • sleep()
    • sleep_ms()
    • sleep_us()
    • strftime()
    • struct_time
    • ticks_ms()
    • ticks_us()
    • ticks_cpu()
    • ticks_add()
    • ticks_diff()
    • time()
    • tzset()
  • Timezone constants
    • altzone
    • daylight
    • timezone
    • tzname
• uio – Input/Output stream functions
  • Returned object types
  • Functions
    • open()
    • Supported file modes
    • Newline behavior
  • Classes
    • TextIO
      • TextIO.read()
      • TextIO.readinto()
      • TextIO.write()
      • TextIO.seek()
      • TextIO.tell()
      • TextIO.flush()
      • TextIO.close()
      • TextIO.writelines()
      • TextIO.readline()
      • TextIO.readlines()
      • TextIO.readable()
      • TextIO.writable()
      • TextIO.seekable()
      • TextIO.truncate()
      • TextIO.buffered
      • TextIO.closed
      • TextIO.mode
      • TextIO.name
      • TextIO.newlines
    • FileIO
    • StringIO
    • BytesIO
• uos – Filesystem functions
  • Functions
    • listdir()
    • mkdir()
    • remove()
    • rmdir()
• uos.path – Filesystem functions
  • Functions
    • isfile()
    • isdir()
    • exists()
• getpass — Portable password input
  • Functions
    • getpass()