netopeer-manager − Modules manager for the netopeer-server
netopeer-manager [−−help] <command> [ <arguments> ]
netopeer-manager provides access to the configuration of the netopeer-server modules. The netopeer-server modules extends its functionality to control another devices or applications via transAPI or just by storing configuration data.
−−help
Prints the generic description and a list of commands. Detailed description and list of arguments for the specific command are displayed by using −−help argument of the command.
add
Add a new netopeer-server module. Added module is
enabled by default and it will be loaded by the
netopeer-server during its next start.
add [−−help] −−name NAME (−−model MODEL | −−augment AUGMENT | −−import IMPORT) [−−transapi TRANSAPI] [−−features FEATURE [FEATURE ...]] [−−datastore DATASTORE]
−−name NAME
Specifies the name of the netopeer-server module. The NAME is used as an identifier of the module in the netopeer-server configuration.
−−model MODEL
Specifies path (absolute or relative) to the module’s main data model in YIN format. In this option, the whole module configuration is created.
−−augment AUGMENT
Specifies path (absolute or relative) to an augment model of the main data model in YIN format. This model is always appended at the end of the model list.
−−import IMPORT
Specifies path (absolute or relative) to a model in YIN format that is imported by the main model. This model is always prepended at the beginning of the model list.
−−transapi TRANSAPI
Optional parameter to specify path to the transAPI module related to the module’s main data model. If the transAPI module is not specified, netopeer-server will allow the configuration data manipulation according to the data model, but the changes will not be applied to any device. This part of the process is handled just by the transAPI module.
−−features FEATURE [FEATURE ...]
Data model can define various features that extend its basic functionality. By default, netopeer-server supposes all features to be disabled. This option explicitly specifies list of features to enable. If one want to enable all features, value * can be used.
−−datastore DATASTORE
Specifies path to the file where the configuration data will be stored. If not specified, datastore is implemented as empty and it will not able to store any configuration data.
list
Print the list of all netopeer-server’s
modules.
list [−−help] [−−name NAME]
−−name NAME
If specified, it is the name of the main netopeer-server module for which the list of extending data models will be printed.
rm
Remove the specified netopeer-server main module.
rm [−−help] −−name NAME [−−model MODEL]
−−name NAME
Specifies the name of the main netopeer-server module to remove.
−−model MODEL
If specified, only this extending model will be removed instead of the whole module.
YIN is an alternative XML-based syntax to YANG language. Both, YANG and YIN, are defined in RFC 6020.
To convert YANG to YIN format, which is required by the Netopeer tools, we recommend to use pyang(1):
$ pyang -f yin data-model.yang -o data-model.yin
netopeer-agent(1),
netopeer-cli(1), netopeer-configurator(1),
netopeer-server(1), pyang(1),
RFC 6020 (YANG Data Modeling Language)
https://netopeer.googlecode.com (Netopeer homepage)
To discuss various topics about netopeer-manager, join the Netopeer mailing list at <https://groups.google.com/group/netopeer>.
Report bugs to the issue tracker at <https://code.google.com/p/netopeer/issues/list>.
Radek Krejci <rkrejci@cesnet.cz>
Copyright © 2014 CESNET, z.s.p.o.