OpenClovis Product Documentation - User contributions [en]

Switch your model/image from TIPC to UDP

2014-07-07T06:51:53Z

Hoangle: /* Step 3 (Cloud mode) */

UDP can be run in two modes -- local or cloud. In local mode, the UDP system uses multicast to find members of the cluster and auto-assigns non-routable IP addresses onto an alias of your chosen backplane network interface. The advantage of local mode is that no IP addresses need to be configured.

In cloud mode, it is assumed that the cluster is potentially running across the entire internet (no multicast) on machines with specified IP addresses. Since no initial discovery is possible, every node needs to be configured with the IP addresses of the two system controller nodes.

== Changing Your Model from TIPC to UDP ==
=== Step 1 ===
- If you have a pre-60 model you will need to upgrade it. Using the IDE open your model, every option will be grey except model->update. This update will generate a configuration file called <your model>/config/clTransport.xml that looks something like this:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit the content clTransport.xml with the UDP configuration details, and remove the TIPC details:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<protocol default="UDP"/>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

=== Step 3 (Local mode) ===
Add 2 environment variables into <model_dir>/src/target.env, or make sure these variables are defined before starting SAFplus:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 3 (Cloud mode) ===
To use the UDP transport without node discovery (multicast) or IP address assignment, you must:

1. Add these 2 environment variables into <model_dir>/src/target.env, or make sure these variables are defined before starting SAFplus:

ASP_UDP_USE_EXISTING_IP=true

ASP_UDP_LINK_NAME=<link name, for example 'eth0'>

2. Configure UDP peer addresses like this:
<code>
<peerAddresses port="6789">
<peer addr="192.168.56.101"/>
<peer addr="192.168.56.102"/>
</peerAddresses>
</code>

The following is a this complete example of a cloud mode configuration file:

<code>
<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<protocol default="UDP"/>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="6789">
<peer addr="192.168.56.101"/>
<peer addr="192.168.56.102"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>
</code>

=== Before or After "make images"? ===
clTransport.xml and target.env can be changed before the "make images" step so all generated images are UDP by default OR these files can be changed on every node after deployment.

== FAQ ==

* Q: Is the SAFplus able to run in UDP local mode as a non-root user?
* A: Yes, but you must properly configure the interfaces since SAFplus cannot.
Configure interface name (ASP_UDP_LINK_NAME) with the IP address calculated from your subnet and node address (ASP_UDP_SUBNET.DEFAULT_NODEADDR). The node address is the DEFAULT_NODEADDR settings from etc/asp.conf file.

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

AMF plugin to influence node arrival/failure detection

2013-10-07T04:07:25Z

Hoangle: Created page with "If you thing internal keepalives mechanism of AMF is not good enough for you, then AMF extension plugin (namely "amfPlugin.so") will provide an optional plugin which can be co..."

If you thing internal keepalives mechanism of AMF is not good enough for you, then AMF extension plugin (namely "amfPlugin.so") will provide an optional plugin which can be coordinate with HW based 'bus' or other protocols can learn of a failure to notify AMF Active/Standby's node status before AMF can handled via keepalives into internal mechanism (TIPC topology, UDP heartbeat).

Example of implementation located at <SAFPlus>/src/examples/notifications/amf/plugins.

To active the plugin, goto this folder and calling 'make', then copy the output (i.e amfPlugin.so) to <SAFplus>/lib on deployment target.

Switch your model/image from TIPC to UDP

2013-06-11T03:50:09Z

Hoangle:

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<protocol default="UDP"/>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Auto IP address assignment ==

To use the UDP transport with the IP address, 'already configured' on a link, set these variables in your environment before starting SAFplus:

ASP_UDP_USE_EXISTING_IP=true
ASP_UDP_LINK_NAME=<link name, for example 'eth0'>

'''clTransport.xml''' should add static IP addresses for cluster:

<peerAddresses port="6789">
<peer addr="192.168.56.101"/>
<peer addr="192.168.56.102"/>
</peerAddresses>

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the static addresses and define variable environments ASP_UDP_USE_EXISTING_IP=true and ASP_UDP_LINK_NAME for getting ip addresses below.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<protocol default="UDP"/>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="6789">
<peer addr="192.168.56.101"/>
<peer addr="192.168.56.102"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-23T09:54:34Z

Hoangle:

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Auto IP address assignment ==

To use the UDP transport with the IP address, 'already configured' on a link, set these variables in your environment before starting SAFplus:

ASP_UDP_USE_EXISTING_IP=true
ASP_UDP_LINK_NAME=<link name, for example 'eth0'>

'''clTransport.xml''' should add static IP addresses for cluster:

<peerAddresses port="6789">
<peer addr="192.168.56.101" slot="1"/>
<peer addr="192.168.56.102" slot="2"/>
</peerAddresses>

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the static addresses and define variable environments ASP_UDP_USE_EXISTING_IP=true and ASP_UDP_LINK_NAME for getting ip addresses below.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="6789">
<peer addr="192.168.56.101" slot="1"/>
<peer addr="192.168.56.102" slot="2"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-23T03:04:14Z

Hoangle: /* UDP without Node Discovery (Multicast) */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the static addresses and define variable environments ASP_UDP_USE_EXISTING_IP=true and ASP_UDP_LINK_NAME for getting ip addresses below.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<staticAddresses>
<staticAddress address="192.168.20.1" slot="1" />
<staticAddress address="192.168.20.2" slot="2"/>
</staticAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-23T03:01:24Z

Hoangle: /* UDP without Node Discovery (Multicast) */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the static addresses and define variable environment ASP_UDP_USE_EXISTING_IP=true.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<staticAddresses>
<staticAddress address="192.168.20.1" slot="1" />
<staticAddress address="192.168.20.2" slot="2"/>
</staticAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-23T02:47:19Z

Hoangle:

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the static addresses and define variable environment ASP_UDP_USE_EXISTING_IP=true.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<staticAddresses>
<staticAddress address="192.168.20.1" slot="1" />
<staticAddress address="192.168.20.2" slot="2"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-21T08:40:45Z

Hoangle: /* Step 2 */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</multixport>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the peer addresses.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="5689">
<peer addr="192.168.20.1"/>
<peer addr="192.168.20.2"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-21T08:40:20Z

Hoangle: /* Step 1 */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</multixport>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</ioc:BootConfig>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the peer addresses.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="5689">
<peer addr="192.168.20.1"/>
<peer addr="192.168.20.2"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

Switch your model/image from TIPC to UDP

2013-05-21T08:39:09Z

Hoangle:

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</ioc:BootConfig>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</ioc:BootConfig>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:

export ASP_UDP_SUBNET=<IP Range>/Length
export ASP_UDP_LINK_NAME=<your interface>

*'''Example:'''

export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
export ASP_UDP_SUBNET=192.168.57.0/24
export ASP_UDP_LINK_NAME=eth0

== UDP without Node Discovery (Multicast) ==

To use the UDP transport without node discovery, you must explicitly configure the peer addresses.

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<multixport xmlns="multixport.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<heartbeat>
<interval>1000</interval>
<intervalLocal>1000</intervalLocal>
<retries>4</retries>
</heartbeat>
<peerAddresses port="5689">
<peer addr="192.168.20.1"/>
<peer addr="192.168.20.2"/>
</peerAddresses>
</multixport>
</version>
</openClovisAsp>

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

== Q&A ==
* Q: Is the SAFplus able to run as a user other than root?
* A: Only pre-requisites, configure interface name (ASP_UDP_LINK_NAME) with IP address (ASP_UDP_SUBNET.DEFAULT_NODEADDR) (Use DEFAULT_NODEADDR settings from asp.conf file)

Example:
root:#ifconfig eth0 192.168.57.1
user:#export ASP_UDP_SUBNET=192.168.57.0/24
user:#export ASP_UDP_LINK_NAME=eth0
user:#./etc/init.d/safplus start

C++ generator for YANG data

2013-03-27T07:30:08Z

Hoangle: /* Using console */

==Checkout Pyang==
* svn checkout http://pyang.googlecode.com/svn/trunk/ /tmp/pyang

==Using console==

* export PYANG_PLUGINPATH=<location of management framework>/pyplugin
* export PYTHONPATH=$PYTHONPATH:/tmp/pyang
* export YANG_MODPATH=/tmp/pyang/modules:<your include YANG data>

$/tmp/pyang/bin/pyang -f y2cpp simple.yang --y2cpp-output <output directory> --y2cpp-mgt <location of management framework>

==Using OpenClovis IDE==

* Select location of Management Framework (calling client lib for mgt object)
**'''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Select Management Framework Location"''' action.

* Defined YANG data model file:
# Create a new yang data model anywhere locate at your project.
# Import YANG data model from '''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Import YANG file"''' action.

* C++ codegen class objects:
** Open Yang Explorer View: '''Window >> Show View >> Yang Explorer View'''. Right click on yang data model from this list viewer (support multi-select items) and select '''"Generator CPP"'''.

C++ generator for YANG data

2013-03-26T04:25:28Z

Hoangle: /* Using console */

==Checkout Pyang==
* svn checkout http://pyang.googlecode.com/svn/trunk/ /tmp/pyang

==Using console==

* export PYANG_PLUGINPATH=<location of management framework>/pyplugin
* export PYTHONPATH=$PYTHONPATH:/tmp/pyang
* export YANG_MODPATH=/tmp/pyang/modules

$pyang -f y2cpp simple.yang --y2cpp-output <output directory> --y2cpp-mgt <location of management framework>

==Using OpenClovis IDE==

* Select location of Management Framework (calling client lib for mgt object)
**'''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Select Management Framework Location"''' action.

* Defined YANG data model file:
# Create a new yang data model anywhere locate at your project.
# Import YANG data model from '''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Import YANG file"''' action.

* C++ codegen class objects:
** Open Yang Explorer View: '''Window >> Show View >> Yang Explorer View'''. Right click on yang data model from this list viewer (support multi-select items) and select '''"Generator CPP"'''.

C++ generator for YANG data

2013-03-26T04:16:22Z

Hoangle: Created page with "==Checkout Pyang== * svn checkout http://pyang.googlecode.com/svn/trunk/ /tmp/pyang ==Using console== * export PYANG_PLUGINPATH=<location of management framework>/pyplugin *..."

==Checkout Pyang==
* svn checkout http://pyang.googlecode.com/svn/trunk/ /tmp/pyang

==Using console==

* export PYANG_PLUGINPATH=<location of management framework>/pyplugin
* export PYTHONPATH=$PYTHONPATH:/tmp/pyang
* export YANG_MODPATH=/tmp/pyang/modules

$pyang -f j2cpp simple.yang --y2cpp-output <output directory> --y2cpp-mgt <location of management framework>

==Using OpenClovis IDE==

* Select location of Management Framework (calling client lib for mgt object)
**'''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Select Management Framework Location"''' action.

* Defined YANG data model file:
# Create a new yang data model anywhere locate at your project.
# Import YANG data model from '''Window >> Show View >> Yang Explorer View''', click at pull down menu and select '''"Import YANG file"''' action.

* C++ codegen class objects:
** Open Yang Explorer View: '''Window >> Show View >> Yang Explorer View'''. Right click on yang data model from this list viewer (support multi-select items) and select '''"Generator CPP"'''.

SAFplus Management Framework

2013-03-26T03:42:44Z

Hoangle: /* Answer: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Deploying and running your model:==
===To install===
:This step is helping to automatically configure port 830 and netconf-subsystem for ssh daemon and define the super user for netconf server.

: root@test-pc:$<model image>/install.sh

===To run the model===

: root@test-pc:$<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection on both yumacli or mgtcli===

===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:'''Hint:''' Go to step installing to make sure netconf-subsystem is listening on port 830.

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

[[C++ generator for YANG data]]

SAFplus Management Framework

2013-02-04T07:56:41Z

Hoangle: /* Answer: */

SAFplus Management Framework

2013-02-04T07:55:25Z

Hoangle: /* Answer: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Deploying and running your model:==
===To install===
:This step is helping to automatically configure port 830 and netconf-subsystem for ssh daemon and define the super user for netconf server.

: root@test-pc:$<model image>/install.sh

===To run the model===

: root@test-pc:$<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection on both yumacli or mgtcli===

===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution:
:: Go to step installing to make sure netconf-subsystem is listening on port 830.

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-02-04T07:54:38Z

Hoangle: /* Answer: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Deploying and running your model:==
===To install===
:This step is helping to automatically configure port 830 and netconf-subsystem for ssh daemon and define the super user for netconf server.

: root@test-pc:$<model image>/install.sh

===To run the model===

: root@test-pc:$<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection on both yumacli or mgtcli===

===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution:
* Go to step installing to make sure netconf-subsystem is listening on port 830.

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-02-04T07:51:49Z

Hoangle: /* Question: NETCONF close your connection with yumacli or mgtcli */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Deploying and running your model:==
===To install===
:This step is helping to automatically configure port 830 and netconf-subsystem for ssh daemon and define the super user for netconf server.

: root@test-pc:$<model image>/install.sh

===To run the model===

: root@test-pc:$<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection on both yumacli or mgtcli===

===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-02-04T07:49:53Z

Hoangle: /* Running your model: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Deploying and running your model:==
===To install===
:This step is helping to automatically configure port 830 and netconf-subsystem for ssh daemon and define the super user for netconf server.

: root@test-pc:$<model image>/install.sh

===To run the model===

: root@test-pc:$<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection with yumacli or mgtcli===
===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-01-31T07:31:36Z

Hoangle: /* YUUMA CLI */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Running your model:==
<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection with yumacli or mgtcli===
===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-01-31T07:31:03Z

Hoangle: /* Testing SET/GET command: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Running your model:==
<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

===YUUMA CLI===
:Should be exporting YUMA_HOME locate in <SAFplus run directory>/share/netconf
:'''Example''':
root@openclovis:/root/SAFplus/ctrlI0# export YUMA_HOME=/root/SAFplus/ctrlI0/share/netconf
root@openclovis:/root/SAFplus/ctrlI0# bin/yangcli

==FAQs:==
===Question: NETCONF close your connection with yumacli or mgtcli===
===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-01-31T07:14:11Z

Hoangle: /* Running testing SET/GET command: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Running your model:==
<model image>/etc/init.d/safplus start

==Testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

==FAQs:==
===Question: NETCONF close your connection with yumacli or mgtcli===
===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-01-31T07:13:49Z

Hoangle: /* Running your model: */

== Download Framework via github ==
root@desktop:/# git clone https://github.com/OpenClovis/SAFplus-Mgt.git <path>

== Building thirdparty library ==

root@desktop:/# cd <path>/3rdparty
root@desktop:<path>/3rdparty# make

==Building CPP component on SAFplus Framework==
This may be done in one of the following two ways:

===Re-building SAFplus===
root@desktop:/# cd <safplusdir>
root@desktop:/# mkdir -p prebuild
root@desktop:/# export BUILD_CPP=1
root@desktop:/# <safplusdir>/src/SAFplus/configure --with-safplus-build
root@desktop:/# cd build/local
root@desktop:/# make

===Building your model with extra configure===
root@desktop:/# cd <project root>
root@desktop:<project root># export BUILD_CPP=1
root@desktop:<project root># <safplusdir>/src/SAFplus/configure '''--with-safplus-build''' --with-model-name=<your model name>
root@desktop:<project root># cd <your model name>/build/local
root@desktop:/# make

==Development your source code==
* Using OpenClovis IDE:
: File -> Import -> General -> Existing Projects into Workspace -> Next -> Locate <git checkout Framework path>/models -> Finish.
:[[File:import_fw_model.png]]

===Defined your YANG model===
: Using vim, gedit or IDE to create your Yang model and put those models into <model>/src/extras/share/netconf/modules.
:*In case you would like to convert YANG model to MIB model, follow instruction at the link: [[Convert YANG to MIB model]] and also put the MIB model at <model>/src/extras/share/snmp/mibs.

===Implementation your model===
:System provides a set of data modeling classes to build a flexible data model which have object-oriented relationships (containment, inheritance, association). User can implement his own C++ classes derived from the MGT base classes to match with the model defined in the input Yang file.

:*ClMgtModule
:*ClMgtObject
:*ClMgtContainer
:*ClMgtList
:*ClMgtIndex
:*ClMgtProvision
:*ClMgtStatistic
:*ClMgtHistoryStatistic
:*ClMgtRpc
:*ClMgtNotification

====Example====

class NetworkInterface : public ClMgtObjectContainer {
private:
ClMgtIndex<string> name; // Interface name ex. "eth0". This is also the index into this data.
/*
* "Prov" objects are "provisioned" -- that is, they are stored in the replicated database.
* When "bind" is called, these object will be loaded from the database's "active" configuration.
* Once bound when the database is modified via an incoming provisioning request, these objects are notified.
* ClMgtProv is a template that wraps provisioning functionality around any fundamental type (by fundamental I mean
* any type that is serializable via memcpy).
*/
ClMgtProv<bool> adminStatus; // Administrative status. If you want this to be "up" set it to "true". "False" = "down"
ClMgtProv<ClIpAddress> ipAddress;
ClMgtProv<ClIpAddress> netMask;
ClMgtProv<ClIpAddress> gateway;
ClMgtStat<uint64_t> errorCount; // Cumulative count of errors
/*
* ClMgtHistoryStat is an in-ram statistic that returns cumulative count AND contains sub-nodes which are arrays of 10 values containing historical (starting now and extending into the past) data:
* 5sec: the cumulative count within second 0-5, 5-10, 10-15, ...
* 1min:
* 5min:
* 1hr:
* 1day:
* 1week:
* 4weeks:
* 1year:
*/
ClMgtHistoryStat<uint64_t> bytesSent;
ClMgtHistoryStat<uint64_t> bytesReceived;
public:
NetworkInterface(const char* objName);
virtual ~NetworkInterface();
void initialize(std::string ifName, ClMgtObject* parent);
void get(void **ppBuffer, ClUint64T *pBuffLen);
void set(void *pBuffer, ClUint64T buffLen, ClTransaction& t = NO_TRANSACTION);
string IpAddress();
};

====Declare your YANG/MIB model:====
:: /*
:: * Declare "<your model name>" module
:: * Should be defined at your main program or header file.
:: */
:: ClMgtModule dataModule("<your model name>");
:: /*
:: * Initialize the module
:: */
:: dataModule.loadModule();

====Initialize mapping between object instance and NETCONF/SNMP model====

*With NETCONF

:*Create object instance:

:: yourclass objectInstance("<name of node tree object intend to create the mapping>")

::'''Example''':

:: /*
:: * Should be defined at your main program or header file.
:: */
:: NetworkInterface netif_eth0("interfaces");

:*Initialize the mapping for object instance:

:: objectInstance.bindNetconf("<your model name>", "<your xpath model>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindNetconf("network", "/ethernet/interfaces[name='eth0']");

*With SNMP

:Replace initialize mapping command with below API

:: object.bindSnmp("<your model name>", "<oid instance>");

::'''Example''':
:: /*
:: * Bind the "active" network interface to
:: * a "/ethernet/interfaces" subtree within
:: * the "network" module.
:: */
:: netif_eth0.bindSnmp("network", "1.3.6.1.4.1.99840.2.1.1");

====Implementation RPC====
: '''This is only valid for NETCONF'''
'''TODO'''

====Implementation Notification====
* Create notification instance:
ClMgtNotify notiInstance("<notification name defined in Yang file>")
Example:
ClMgtNotify addrFailoverNotify("AddressFailover");
* Add notification parameters:
notiInstance.addLeaf("<leaf name>", "<default value>")
Example:
addrFailoverNotify.addLeaf("ipAddress", netif_eth0.IpAddress());
* Add notification to module:
yangModule.addMgtNotify(&notiInstance)
Example:
yangModule.addMgtNotify(&addrFailoverNotify);
* Send notification:
notiInstance.sendNotification()
Example:
addrFailoverNotify.sendNotification();

==Building your model:==
Right click project -> Build Project
 

==Running your model:==
<model image>/etc/init.d/safplus start

==Running testing SET/GET command:==
===Mgt CLI===
root@openclovis:/root/SAFplus/ctrlI0# python bin/mgtcli.py

Management info cli -- OpenClovis, Inc., 2012
---------------------------------------------
Starting interactive prompt (type 'help' for help)
[MgtCli]==> add element --host=127.0.0.1 --name=openclovis --user=root --password=clovis
Connecting to openclovis
Done!

[MgtCli]==> ls openclovis/
openclovis/arp openclovis/ethernet openclovis/interfaces
[MgtCli]==> ls openclovis/ethernet/
interfaces: {'name': 'eth0'}
interfaces: {'name': 'eth1'}

[MgtCli]==> ls openclovis/ethernet/interfaces
openclovis/ethernet/interfaces[name=eth0]:
adminStatus: false
bytesReceived: 705477592
bytesSent: 160825231
errorCount: 0
gateway: 0.0.0.0
ipAddress: 10.20.15.37
name: eth0
netMask: 255.255.255.0

openclovis/ethernet/interfaces[name=eth1]:
adminStatus: false
bytesReceived: 0
bytesSent: 0
errorCount: 0
gateway: 0.0.0.0
ipAddress: 255.127.0.0
name: eth1
netMask: 255.127.0.0

[MgtCli]==>

===NETSNMP===
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 0
root@openclovis:/root/SAFplus/ctrlI0# snmpset -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1.0 u 1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.1
SNMPv2-SMI::enterprises.99840.1.0 = Gauge32: 1
root@openclovis:/root/SAFplus/ctrlI0#

root@openclovis:/root/SAFplus/ctrlI0# snmpwalk -v 2c -c clovis localhost:1610 1.3.6.1.4.1.99840.2.1
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.48 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.1.4.101.116.104.49 = INTEGER: 0
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.48 = Hex-STRING: 65 74 68 30 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.2.4.101.116.104.49 = Hex-STRING: 65 74 68 31 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.48 = Hex-STRING: 31 30 2E 32 30 2E 31 35 2E 33 37 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.3.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.48 = Hex-STRING: 32 35 35 2E 32 35 35 2E 32 35 35 2E 30 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.4.4.101.116.104.49 = Hex-STRING: 32 35 35 2E 31 32 37 2E 30 2E 30 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.48 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.5.4.101.116.104.49 = Hex-STRING: 30 2E 30 2E 30 2E 30 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.48 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.6.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.48 = Gauge32: 160719241
SNMPv2-SMI::enterprises.99840.2.1.1.7.4.101.116.104.49 = Gauge32: 0
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.48 = Gauge32: 705216763
SNMPv2-SMI::enterprises.99840.2.1.1.8.4.101.116.104.49 = Gauge32: 0

==FAQs:==
===Question: NETCONF close your connection with yumacli or mgtcli===
===Answer:===
:This may cause by your sshd deamon Subsystem is still not running normal.
:Solution: If you are running your model with non-root user, port 830 cannot being listening. Your should manual running the script at <model image>/etc/init.d/customerScript.sh with root privileges and test your connect with below command:

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh start --> to start sshd listening

:or

:: root@desktop:/#sudo <model image>/etc/init.d/customerScript.sh stop --> to stop sshd listening

===Question: NETSNMP respone with timeout for snmpwalk/snmpget/snmpset command===
===Answer:===
: The snmp master agent is listening on port 1610 and communication string is "clovis". Those params can be defined by your at <model>/src/config/snmpd.conf.

===Question: 3rdparty build failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos)===
===Answer:===
root@desktop:/# sudo yum install libgcrypt-devel

[[Using Management CLI]]

SAFplus Management Framework

2013-01-24T02:22:57Z

Hoangle: /* Implementation RPC for YANG model */

SAFplus Management Framework

2013-01-24T02:21:33Z

Hoangle: /* Initialize maping between object instance and YANG/MIB model */

SAFplus Management Framework

2013-01-24T02:18:48Z

Hoangle: /* Declare your YANG/MIB model: */

SAFplus Management Framework

2013-01-23T08:34:10Z

Hoangle: /* FAQs: */

SAFplus Management Framework

2013-01-23T08:33:46Z

Hoangle: /* Answer */

SAFplus Management Framework

2013-01-23T08:32:48Z

Hoangle: /* Answer */

SAFplus Management Framework

2013-01-23T08:32:32Z

Hoangle: /* Answer */

SAFplus Management Framework

2013-01-23T08:32:13Z

Hoangle: /* Answer */

SAFplus Management Framework

2013-01-23T08:31:28Z

Hoangle: /* Declare your YANG/MIB model: */

SAFplus Management Framework

2013-01-23T08:30:17Z

Hoangle: /* Initialize maping between object instance and YANG/MIB model */

Using Management CLI

2013-01-23T07:48:06Z

Hoangle: Created page with " '''TODO'''"

'''TODO'''

SAFplus Management Framework

2013-01-23T07:47:16Z

Hoangle:

Switch your model/image from TIPC to UDP

2013-01-23T07:19:49Z

Hoangle: /* Step 1 */

Switch your model/image from TIPC to UDP

2013-01-23T07:19:17Z

Hoangle: /* Step 4 */

Switch your model/image from TIPC to UDP

2013-01-23T07:19:01Z

Hoangle: /* Step 3 */

SAFplus Management Framework

2013-01-23T07:14:19Z

Hoangle: /* FAQ: */

Convert YANG to MIB model

2013-01-23T07:13:30Z

Hoangle:

==Introduction==
:YANG2SMI is an extensible output plugin for pyang. This plugin can be used to generate MIB model from YANG model data.

Step to convert YANG to MIB model:
# You need an installation of pyang:
## cd <SAFplus-Management-Framework>/3rdparty
## make pyang
#Add the YANG2SMI plugin to your existing pyang installation. This may be done in one of the following three ways:
##Add <SAFplus-Management-Framework>/model/src/extras/pyplugin/yang2smi.py to <SAFplus-Management-Framework>/3rdparty/pyang/pyang/plugins,
##Add the location of <SAFplus-Management-Framework>/model/src/extras/pyplugin/yang2smi.py to the $PYANG_PLUGINPATH environment variable, or
##Use the --plugindir option of pyang each time you want to use YANG2SMI
#Change directory to <SAFplus-Management-Framework>/3rdparty/pyang and launch pyang with specific yang2smi output format, YANG module file, OID root module and MIB model file.

For example, to generate the network.yang to NETWORK.MIB , type:
root@desktop:/# source env.sh;./bin/pyang -f yang2smi network.yang --yang2smi-oid=99840 -o NETWORK.MIB

SAFplus Management Framework

2013-01-23T07:09:49Z

Hoangle: /* Question: Make 3rdparty failed at libssh2: Need OpenSSL or Libgcrypt (such as Fedora or Centos) */

SAFplus Management Framework

2013-01-23T07:08:41Z

Hoangle: /* Answer */

SAFplus Management Framework

2013-01-23T07:07:38Z

Hoangle: /* Question: Cannot connect to NETCONF */

SAFplus Management Framework

2013-01-23T06:57:12Z

Hoangle: /* Rebuild SAFplus */

SAFplus Management Framework

2013-01-23T06:56:47Z

Hoangle: /* Build CPP component on SAFplus Framework */

SAFplus Management Framework

2013-01-23T06:55:12Z

Hoangle: /* Binding your object instance into YANG or MIB model with follow command: */

SAFplus Management Framework

2013-01-23T06:41:25Z

Hoangle: /* Declare your YANG/MIB model: */

SAFplus Management Framework

2013-01-23T06:32:53Z

Hoangle: /* Create your object implementor that derive from ClMgtObject mainly base class */

SAFplus Management Framework

2013-01-23T06:27:46Z

Hoangle: /* Defined your YANG model view at /src/extras/share/netconf/modules */

SAFplus Management Framework

2013-01-23T06:23:41Z

Hoangle: /* Launch OpenClovis IDE and Import Framework Model (i.e /model) */

SAFplus Management Framework

2013-01-23T06:13:35Z

Hoangle: /* Need to rebuild SAFplus SDK with environment variable BUILD_CPP=1 */