opc

Documentation

Overview

Opc is the command line interface to opd operational commands. It provides all functions needed to implement the Vyatta CLI.

Usage:

opc [ options ] path
Options:
-op=[run|complete|help|expand|tmpl|children|allowed|field|getperms]
	Default: run
	The op flag is the operation to request from opd.
	More details are described below for each operation.

	run: The run operation requests opd run the supplied command
		path.  If the user is allowed to run this command by the
		authorization service, the command will be executed by opd
		and opc will then connect to the sockets attached to that
		exec'd processes pty.

	complete: The complete operation returns a list of possible
		next completions for the supplied path. When used in
		conjunction with the -prefix flag,only the completions
		matching the supplied prefix are printed. This is used by
		the bash completion scripts implementing the Vyatta CLI.

	help: The help operation returns a the pretty printed help
		text for the supplied path.  When used in conjunction with
		the -prefix flag, only the completions matching the
		supplied prefix are shown. This is used by the bash
		completion scripts implmenting the Vyatta CLI.

	expand: The expand operation returns a fully expanded Vyatta
		command path. Paths in the Vyatta CLI may be abbreviated
		such that the shortest un-ambiguous match is accepted as a
		valid command. Expand will return the fully qualified path
		when given an un-ambiguous path, or an error string when
		given an ambiguous path.

	tmpl: The tmpl operation returns a text representation of the
		operational template at the supplied path. This template
		is a pretty printed form of the templates present in the
		template tree.

	children: The children operation returns a list of children
		for the given path.

	allowed: The allowed operation returns a list allowed values
		for the given tag node. If the allowed operation is called
		on a non tag node then it will report an error.

	field: The field operation returns a single field value from a
		template. This is a helper function implemented using the
		tmpl operation. Field requires that the -field flag be
		defined.

	getperms: The getperms operation returns a subset of the
		operational mode ruleset that affects the current user.

-field=<field> The field flag defines the field to extract from a
	template.

-prefix=<prefix> The prefix flag is the prefix to filter for the
	help and complete operations.

-debug Default: false The debug flag enables RPC request/response
	debugging.