Package onep :: Package applmgmt :: Module ApplicationCli :: Class ApplicationCli
[frames] | no frames]

Class ApplicationCli

The ApplmgmtData class represents application managed data that reside in the network element.

Instance Methods
 
__init__(self, element, version, instance, config_domain)
Constructor for ApplicationCli.
str
get_config(self, data_name)
Retrieve the configuration for the given application data managed by Network Element CLI interface.
 
set_config_listener(self, listener, client_data)
Sets the ApplicationConfigCliListener for the network element.
ApplicationConfigCliListener
get_config_listener(self)
Gets the ApplmgmtConfigEvent listener for the network element.
 
set_exec_listener(self, listener, client_data)
Sets the ApplicationExecCliListener for application's show data action.
ApplicationExecCliListener
get_exec_listener(self)
Get a ApplmgmtShowEvent listener to the network element.
Method Details

__init__(self, element, version, instance, config_domain)
(Constructor)

 

Constructor for ApplicationCli.

Parameters:
  • element (NetworkElement) - The network element to which the application CLI will be applied.
  • version (str) - The CLI version which the application will use.
  • instance (str) - The instance identifier which the application will use.
  • config_domain (str) - The configuration domain identifier which the application will use. This must be supplied for end-node hosted applications. If application is running in a container, the container name will be used.
Raises:

get_config(self, data_name)

 

Retrieve the configuration for the given application data managed by Network Element CLI interface.

Parameters:
  • data_name - The name of the variable whose value needs to be retrieved.
Returns: str
A string containing the value of the data
Raises:

set_config_listener(self, listener, client_data)

 

Sets the ApplicationConfigCliListener for the network element.

The ApplicationConfigCliListener will be invoked when the application-defined configuration commands are applied on the network element.

Note: The listener is singular that is, if a listener has been set before, the new listener will replace the previous one.

Parameters:
Raises:

get_config_listener(self)

 

Gets the ApplmgmtConfigEvent listener for the network element.

Returns: ApplicationConfigCliListener
The ApplmgmtConfigEvent listener.

set_exec_listener(self, listener, client_data)

 

Sets the ApplicationExecCliListener for application's show data action.

The listener is invoked when the network administrator issues a show CLI for the application data.

Note: The listener is singular that is, if a listener has been set before, the new listener will replace the previous one.

Parameters:
Raises:

get_exec_listener(self)

 

Get a ApplmgmtShowEvent listener to the network element.

Returns: ApplicationExecCliListener
The ApplmgmtExecCliEvent listener.