ImportPy

SCPI Commands

ROUTe:PATH:IMPort:DELete
ROUTe:PATH:IMPort:DELete:ALL
ROUTe:PATH:IMPort

class ImportPy

ImportPy commands group definition. 4 total commands, 1 Sub-groups, 3 group commands

class ValueStruct

Structure for setting input parameters. Contains optional set arguments. Fields:

• Import_Filename: str: String parameter to specify the name of the file to be loaded.

• Replace_Or_Keep: enums.ReplaceOrKeep: Optional setting parameter. Optional parameter that decides about keeping or replacing the currently existing path definitions, see ‘Import Paths’. If the parameter is missing, the import is performed in REPLace mode.

  • KEEP: Amends the current path definitions in the switch unit’s internal memory with the imported path definitions.However, if you import paths that have the same names as existing paths in the memory, the imported paths overwrite the existing paths, even if you have specified to KEEP them.

  • REPLace: Discards the current path definitions in the switch unit’s internal memory and replaces them with the imported path definitions.

delete(path_config_file: str) → None

# SCPI: ROUTe:PATH:IMPort:DELete
driver.route.path.importPy.delete(path_config_file = '1')

Risk of losing settings: Removes the specified path configuration file from the switch unit’s compact flash memory. All path filenames have the extension ‘.path’. Do not enter the extension when specifying a filename. A filename query does not return the extension. For example, when you save the path file ‘gen-pa_1’, it is saved as ‘gen-pa_1.path’. A query returns this filename as ‘gen-pa_1’, only. If the specified file does not exist, a SCPI error is generated. You can query the error with SYST:ERR?. The result can be, for example: -200,’Execution error;File does not exist. ,ROUTe:PATH:IMPort:DELete ‘’Path5’’’ The command MMEMory:DELete is equivalent with method RsOsp.Route.Path.ImportPy. delete.

param path_config_file

String parameter to specify the name of the file to be deleted.

delete_all(path_information: Optional[str] = None) → None

# SCPI: ROUTe:PATH:IMPort:DELete:ALL
driver.route.path.importPy.delete_all(path_information = '1')

Risk of losing settings: Removes all path configuration files from the switch unit’s compact flash memory. Before you delete all path configuration files, we recommend using the command method RsOsp.Route.Path.ImportPy.Catalog. get_ to query all currently defined path configuration files.

param path_information

No help available

set_value(value: RsOsp.Implementations.Route_.Path_.ImportPy.ImportPy.ValueStruct) → None

# SCPI: ROUTe:PATH:IMPort
driver.route.path.importPy.set_value(value = ValueStruct())

Loads a set of path configurations from a file on the compact flash memory into the switch unit’s internal volatile memory. All path filenames have the extension ‘.path’. Do not enter the extension when specifying a filename. A filename query does not return the extension. For example, when you save the path file ‘gen-pa_1’, it is saved as ‘gen-pa_1.path’. A query returns this filename as ‘gen-pa_1’, only. If the specified file does not exist, a SCPI error is generated. You can query the error with SYST:ERR?. The result can be, for example: -200,’Execution error;Restoring device from file /opt/ospn/exportPath5.path failed,ROUTe:PATH:IMPort ‘’Path5’’’ The legacy command MMEM:LOAD:STATe is equivalent with method RsOsp.Route.Path.ImportPy.value. However, MMEM:LOAD:STATe does not support the parameter <import mode>, which is used with method RsOsp.Route.Path.ImportPy.value to specify keeping or replacing the path definitions (see below) . Risk of losing settings: Note that this command overwrites all current path definitions in the switch unit’s internal volatile memory with the path definitions in the loaded file. To avoid losing current path definitions, consider saving these definitions by method RsOsp.Route.Path.export, before you send the import command.

param value

see the help for ValueStruct structure arguments.

Subgroups

• Catalog