NetConf Call Home Commands
This chapter describes these commands:
callhome server
Use this command to add a call home server. A maximum 5 servers can be configured.
Use the no form of this command to delete a call home server. If the specified call home server is already connected with the OcNOS NetConf server, deleting it will not disconnect it.
Command Syntax
callhome server WORD (A.B.C.D|X:X::X:X|HOSTNAME) (port <1-65535>|)
no callhome server WORD
Parameters
WORD
An arbitrary name for the NetConf listen endpoint. Any valid string with length 1-64 can be used.
A.B.C.D
IPv4 address of the call home server
X:X::X:X
IPv4 address of the call home server
HOSTNAME
Host name of the call home server
<1-65535>
Callhome server listening port
Note: The same address can be configured with different endpoint names, so use a different port number in those cases. For example:
callhome server name-1 1.1.1.1
callhome server name-2 1.1.1.1 # Avoid this is kind of redundant configuration
callhome server name-3 1.1.1.1 5555
Default
Default value for the port is IANA assigned port 4334.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#
(netconf-callhome)#callhome server remote-client 169.154.45.12
(netconf-callhome)#callhome server nat-client 192.168.56.1 port 12234
(netconf-callhome)#commit
(netconf-callhome)#
config)#do show running-config netconf-callhome
(config)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
callhome server remote-client 169.154.45.12
callhome server nat-client 192.168.56.1 port 12234
!
(netconf-callhome)#
(netconf-callhome)#no callhome server nat-client
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
callhome server remote-client 169.154.45.12
!
(netconf-callhome)#
debug callhome
Use this command to enable debugging for the call home module. Once enabled, all debugging related informatuion will be logged in the system logger file.
Use the no form of this command to disable debugging for the call home module.
Command Syntax
debug callhome
no debug callhome
Parameters
None
Default
By default, debugging is disabled (only critical message are enabled).
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(config)#
(config)#netconf callhome
(netconf-callhome)#do show running-config netconf-callhome
(netconf-callhome)#
(netconf-callhome)#debug callhome
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
debug callhome
!
(netconf-callhome)#no debug callhome
(netconf-callhome)#commit
(netconf-callhome)#do show running-config netconf-callhome
(netconf-callhome)#
feature netconf callhome
Use this command to enable or disable the NetConf call home feature. When the feature is disabled, all other configurations are removed except
debug callhome.
Enabling the call home feature is required before doing any other call home configurations.
Command Syntax
feature netconf callhome (enable|disable)
Parameters
enable
Enable the call home feature
disable
Disable the call home feature
Default
By default, the call home feature is disabled.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(config)#do show running-config netconf-callhome
(config)#
(config)#netconf callhome
(netconf-callhome)#feature netconf callhome enable
(netconf-callhome)#commit
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#feature netconf callhome disable
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
(netconf-callhome)#
management-port
Use this command to add an interface to use to connect to a call home server. This is useful when in-band (front panel) ports are used as management ports.
Use the no form of this command to use eth0 as the management port.
Command Syntax
management-port IFNAME
no management-port
Parameters
IFNAME
Interface used to connect to the call home server
Default
By default, eth0 (out-of-band management port) is used as the management port.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0
Example
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#management-port xe4
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
management-port xe4
!
(netconf-callhome)#no management-port
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#
netconf callhome
Use this command to enter NetConf call home configuration mode. All call home configurations are done in this mode.
Command Syntax
netconf callhome
Mode
Configure mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(config)#netconf callhome
(netconf-callhome)#
reconnect
Use this command to enable or disable the reconnect feature. If disabled, OcNOS only tries once and if it fails, the connection will not be re-attempted.
Command Syntax
reconnect (enable|disable)
Parameters
enable
Enable reconnect
disable
Disable reconnect
Default
By default, the reconnect feature is not enabled.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#reconnect enable
(netconf-callhome)#commit
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#retry-max-attempts 10
(netconf-callhome)#retry-interval 30
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-max-attempts 10
retry-interval 30
!
(netconf-callhome)#reconnect disable
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#
retry-interval
Use this command to specify the number of seconds to wait after a connect attempt to the call home server fails.
Use the no form of this command to reset the retry interval to its default (300 seconds).
Command Syntax
retry-interval <1-86400>
no retry-interval
Parameters
<1-86400>
Retry interval in seconds
Default
By default, when the
reconnect feature is enabled, the default retry interval is 300 seconds.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#retry-interval 100
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-interval 100
!
(netconf-callhome)#
(netconf-callhome)#no retry-interval
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#
retry-max-attempts
Use this command to specify the number of retries the OcNOS should attempt to the call home server before giving up.
Use the no form of this command to reset the maximum attempts to its default (3).
Command Syntax
retry-max-attempts <0-255>
no retry-max-attempts
Parameters
<0-255>
Number of retries; specify zero (0) to retry infinitely
Default
By default, when the
reconnect feature is enabled, 3 attempts will be made.
Mode
NetConf call home mode
Applicability
This command was introduced in OcNOS version 6.0.0.
When reconnect parameters are updated:
• Servers for which the configured retry count has not completed, with updated configurations, those will also get counted.
• Servers for which the configured retry count has already completed, new configuration will restart retrial.
Example
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#retry-max-attempts 10
(netconf-callhome)#commit
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-max-attempts 10
!
(netconf-callhome)#no retry-max-attempts
(netconf-callhome)#commit
(netconf-callhome)#
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#
show (xml|) running-config netconf-callhome
Use this command to display call home configurations.
Command Syntax
show (xml|) running-config netconf-callhome
Parameters
xml
Display the output in XML format
Mode
Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
management-port xe10
reconnect enable
retry-max-attempts 10
retry-interval 100
callhome server local-nc 192.168.56.1
debug callhome
!
#show xml running-config netconf-server
<netconf-server xmlns="http://www.ipinfusion.com/yang/ocnos/ipi-management-server">
<callhome>
<feature-enabled></feature-enabled>
<management-port>xe10</management-port>
<netconf-client>
<name>local-nc</name>
<address>192.168.56.1</address>
</netconf-client>
<reconnect>
<enable></enable>
<retry-max-attempts>10</retry-max-attempts>
<retry-interval>100</retry-interval>
</reconnect>
</callhome>
<debug>
<callhome-debug></callhome-debug>
</debug>
</netconf-server>