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)
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-3 1.1.1.1 port 5555
Avoid the redundant configuration: callhome server name-2 1.1.1.1
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
The below configuration example illustrates how to define and manage callhome servers for NetConf communication.
1. Check the existing NetConf Callhome configuration usingthe show running-config netconf-callhome command.
(config)#netconf callhome
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
2. Configure the Callhome server.
(netconf-callhome)#callhome server name-1 169.154.45.12
(netconf-callhome)#callhome server nmae-2 192.168.56.1 port 12234
(netconf-callhome)#commit
3. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
callhome server name-1 169.154.45.12
callhome server name-2 192.168.56.1 port 12234
!
4. Remove the configured name-2 Callhome server.
(netconf-callhome)#no callhome server name-2
(netconf-callhome)#commit
5. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
callhome server name-1 169.154.45.12
!
(netconf-callhome)#exit
debug callhome
Use this command to enable debugging for the call home module. Once enabled, all debugging related information 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
The below configuration example illustrates how to enable or disable debugging for the Callhome module.
1. Check the existing NetConf Callhome configuration using the show running-config netconf-callhome command.
(config)#netconf callhome
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
!
2. Enable debug command for the Callhome module.
(netconf-callhome)#debug callhome
(netconf-callhome)#commit
3. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
debug callhome
!
4. Remove the configured debug command to disable debugging for the call home module.
(netconf-callhome)#no debug callhome
(netconf-callhome)#commit
5. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
!
(netconf-callhome)#exit
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
The below configuration example illustrates how to enable or disable the NetConf Callhome feature.
1. Check the existing NetConf Callhome configuration using the show running-config netconf-callhome command.
(config)#do show running-config netconf-callhome
(config)#
2. Enable the NetConf Callhome feature.
(config)#netconf callhome
(netconf-callhome)#feature netconf callhome enable
(netconf-callhome)#commit
3. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
4. Disable the NetConf callhome feature.
(netconf-callhome)#feature netconf callhome disable
(netconf-callhome)#commit
5. Check the current NetConf Callhome configurations using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
!
(netconf-callhome)#exit
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
The below configuration example illustrates how to enable or disable the NetConf Callhome feature.
1. Check the existing NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
2. Using the management port command, add an interface xe4 to connect to the call home server.
(netconf-callhome)#management-port xe4
(netconf-callhome)#commit
3. Check the current NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
management-port xe4
!
4. Remove the connected interface xe4 using the no command, and by default, eth0 is used as the management port.
(netconf-callhome)#no management-port
(netconf-callhome)#commit
5. Check the current NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
(netconf-callhome)#exit
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
1. The below configuration example illustrates how to enter the NetConf Callhome configuration mode.
#configure terminal
(config)#netconf callhome
2. Check the NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
!
(netconf-callhome)#exit
reconnect
Use this command to enable or disable the reconnect feature in OcNOS, allowing users to control whether the system attempts to re-establish a connection if it fails. When enabled, OcNOS will make repeated connection attempts if the initial connection fails. If disabled, OcNOS will make only a single connection attempt; if it fails, it will not re-attempt the connection.
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
1. Check the existing NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
!
2. Enable Reconnect:
(netconf-callhome)#reconnect enable
(netconf-callhome)#commit
3. Check the current NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
4. Configure Retry Attempts and Interval for the system to re-establish a connection after failing a maximum number of attempts with a specified time interval.
(netconf-callhome)#retry-max-attempts 10
(netconf-callhome)#retry-interval 30
(netconf-callhome)#commit
5. Check the current NetConf Callhome configuration using the show running-config netconf-callhome command.
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-max-attempts 10
retry-interval 30
!
6. Disable Reconnect:
(netconf-callhome)#reconnect disable
(netconf-callhome)#commit
7. Check the current NetConf Callhome configuration using the show running-config netconf-callhome command.
(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
1. Enable the NetConf callhome feature and reconnect commands:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
2. Configure retry interval:
(netconf-callhome)#retry-interval 100
(netconf-callhome)#commit
(netconf-callhome)#
3. Check the NetConf callhome show output:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-interval 100
!
4. Reset the interval:
(netconf-callhome)#no retry-interval
(netconf-callhome)#commit
5. Check the NetConf callhome show output:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#exit
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 value (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 users update the reconnect parameters, note the following:
• Servers that haven't completed the configured retry count with the updated configurations will be included in the new count.
• Servers for which the configured retry count has already been completed will restart the retrial process with the new configuration.
Example
1. Enable the NetConf callhome feature and reconnect commands:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
2. Configure retry maximum attempts:
(netconf-callhome)#retry-max-attempts 10
(netconf-callhome)#commit
(netconf-callhome)#
3. Check the NetConf callhome show output:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
retry-max-attempts 10
!
4. Reset the attempts to its default value:
(netconf-callhome)#no retry-max-attempts
(netconf-callhome)#commit
5. Check the NetConf callhome show output:
(netconf-callhome)#do show running-config netconf-callhome
!
netconf callhome
feature netconf callhome enable
reconnect enable
!
(netconf-callhome)#exit
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
The below show command displays the running configuration of the Netconf Callhome feature in a normal format.
#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
!
The below show command displays the running configuration of the Netconf Callhome feature in XML format.
#show xml running-config netconf-callhome
<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>