https://docs.telcobridges.com/w/api.php?action=feedcontributions&feedformat=atom&user=Miguel+Celis+SalgadoTB Wiki - User contributions [en]2026-07-27T21:33:13ZUser contributionsMediaWiki 1.41.1https://docs.telcobridges.com/w/index.php?title=Toolpack:Configure_HTTPS_certificates_A&diff=31881Toolpack:Configure HTTPS certificates A2022-08-17T15:35:16Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:Configure HTTPS certificates}}<br />
{| class="wikitable"<br />
|-<br />
|rowspan="3"|This article applies to:<br />
|'''Product'''<br />
|'''Version'''<br />
|-<br />
|Tmedia<br />
|2.9, 2.10, 3.0, 3.2<br />
|-<br />
|ProSBC<br />
|3.1, 3.1.117 or later<br />
|}<br />
If you created a HTTP service using HTTPS and want to have an officially signed certificate, follow these steps<br />
<br />
<br />
1. Activate the HTTPS on the unit to have the system generate a self-signed certificate.<br />
<br />
2. Log in as root using SSH to your unit and go to /lib/tb/toolpack/pkg/ssl_certificate.<br />
cd /lib/tb/toolpack/pkg/ssl_certificate<br />
<br />
3. Create a 'certificate signing request' form and private key using the following command:<br />
openssl req -out CSR.csr -new -newkey rsa:2048 -nodes -keyout privateKey.key<br />
You will be prompted for information. One of the prompts is for the 'common name'. Set it to the URL that you will use to access the unit. If an IP address is used, we strongly recommend it to either be static or 'reserved' in the DHCP. <br />
<br />
For example:<br />
https://192.168.130.3:12358 -> common name = 192.168.130.3<br />
https://myunit.lan:12358 -> common name = myunit.lan<br />
4. The previous step should have created two files:<br />
CSR.csr<br />
privateKey.key<br />
5. Download the generated CSR.csr from your unit (using SCP) and sent it to your signing authority to get a signed certificate.<br />
<br />
6. Once you have the signed certificate, upload it to your unit (using SCP) in the same directory as before.<br />
<br />
7. Concatenate the private key and signed certificate and replace the contents of the file toolpack_cert.pem<br />
rm -f toolpack_cert.*<br />
cat privateKey.key <yoursignedcertificatefile> > toolpack_cert.pem<br />
<br />
8. Restart the Webportal process to load the new certificate.<br />
killall lighttpd</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=Toolpack:Configure_HTTPS_certificates_A&diff=31880Toolpack:Configure HTTPS certificates A2022-08-17T15:27:59Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:Configure HTTPS certificates}}<br />
{| class="wikitable"<br />
|-<br />
|rowspan="3"|This article applies to:<br />
|'''Product'''<br />
|'''Version'''<br />
|-<br />
|Tmedia<br />
|2.9, 2.10, 3.0, 3.2<br />
|-<br />
|FreeSBC, ProSBC<br />
|3.1, 3.1.117 or later<br />
|}<br />
If you created a HTTP service using HTTPS and want to have an officially signed certificate, follow these steps<br />
<br />
<br />
1. Activate the HTTPS on the unit to have the system generate a self-signed certificate.<br />
<br />
2. Log in as root using SSH to your unit and go to /lib/tb/toolpack/pkg/ssl_certificate.<br />
cd /lib/tb/toolpack/pkg/ssl_certificate<br />
<br />
3. Create a 'certificate signing request' form and private key using the following command:<br />
openssl req -out CSR.csr -new -newkey rsa:2048 -nodes -keyout privateKey.key<br />
You will be prompted for information. One of the prompts is for the 'common name'. Set it to the URL that you will use to access the unit. If an IP address is used, we strongly recommend it to either be static or 'reserved' in the DHCP. <br />
<br />
For example:<br />
https://192.168.130.3:12358 -> common name = 192.168.130.3<br />
https://myunit.lan:12358 -> common name = myunit.lan<br />
4. The previous step should have created two files:<br />
CSR.csr<br />
privateKey.key<br />
5. Download the generated CSR.csr from your unit (using SCP) and sent it to your signing authority to get a signed certificate.<br />
<br />
6. Once you have the signed certificate, upload it to your unit (using SCP) in the same directory as before.<br />
<br />
7. Concatenate the private key and signed certificate and replace the contents of the file toolpack_cert.pem<br />
rm -f toolpack_cert.*<br />
cat privateKey.key <yoursignedcertificatefile> > toolpack_cert.pem<br />
<br />
8. Restart the Webportal process to load the new certificate.<br />
killall lighttpd</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31864ProSBC:Cloud:AWS Installation-B2022-08-01T18:27:58Z<p>Miguel Celis Salgado: /* Optional: Elastic IP Creation section */</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
* After a few minutes your instance should be running and available to be configure:<br />
<br />
[[File:EC2 AMI Instances.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers that the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommend to associate an Elastic IP to your instance, that is in short to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31863ProSBC:Cloud:AWS Installation-B2022-08-01T18:26:06Z<p>Miguel Celis Salgado: /* Optional: Elastic IP Creation section */</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
* After a few minutes your instance should be running and available to be configure:<br />
<br />
[[File:EC2 AMI Instances.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers that the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommend to associate an Elastic IP to your instance, that is in short to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS here.<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31862ProSBC:Cloud:AWS Installation-B2022-08-01T18:24:14Z<p>Miguel Celis Salgado: /* Optional: Elastic IP Creation section */</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
* After a few minutes your instance should be running and available to be configure:<br />
<br />
[[File:EC2 AMI Instances.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers that the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommend to associate an Elastic IP to your instance that is in short a fixed public IP for your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS here.<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31861ProSBC:Cloud:AWS Installation-B2022-08-01T18:23:43Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
* After a few minutes your instance should be running and available to be configure:<br />
<br />
[[File:EC2 AMI Instances.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* AWS will automatically provide and allocate a dynamic public IP to a your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers that the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommend to associate an Elastic IP to your instance that is in short a fixed public IP for your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS here. <br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31860ProSBC:Cloud:AWS Installation-B2022-08-01T16:11:12Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
* After a few minutes your instance should be running and available to be configure:<br />
<br />
[[File:EC2 AMI Instances.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_Instances.png&diff=31859File:EC2 AMI Instances.png2022-08-01T16:11:01Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI_Instances</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31858ProSBC:Cloud:AWS Installation-B2022-08-01T15:35:49Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31857ProSBC:Cloud:AWS Installation-B2022-08-01T15:30:53Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:<br />
<br />
[[File:EC2 AMI Launch.png|900px|thumb|center]]<br />
<br />
* You should receive the confirmation of the launching process, this process will take some time until the instances is available, You can view your instance by clicking on “View Instances”:<br />
<br />
[[File:EC2 AMI Confirmation.png|900px|thumb|center]]<br />
<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_Confirmation.png&diff=31856File:EC2 AMI Confirmation.png2022-08-01T15:30:14Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI_Confirmation</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_Launch.png&diff=31855File:EC2 AMI Launch.png2022-08-01T15:21:19Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2 _AMI_Launch</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31854ProSBC:Cloud:AWS Installation-B2022-08-01T15:12:42Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
<br />
* Name the instance and add any necessary tag<br />
[[File:EC2-AMI Launch.png|900px|thumb|center]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.<br />
<br />
[[File:EC2 AWS Key pair.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2. <br />
<br />
[[File:EC2 AMI Storage.png|900px|thumb|center]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_Storage.png&diff=31853File:EC2 AMI Storage.png2022-08-01T15:11:54Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI_Storage</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AWS_Key_pair.png&diff=31852File:EC2 AWS Key pair.png2022-08-01T14:53:27Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2 _AWS_Key_pair</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2-AMI_Launch.png&diff=31851File:EC2-AMI Launch.png2022-08-01T14:31:45Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2-AMI_Launch</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31850ProSBC:Cloud:AWS Installation-B2022-07-29T15:43:40Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31849ProSBC:Cloud:AWS Installation-B2022-07-29T15:38:58Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31848ProSBC:Cloud:AWS Installation-B2022-07-29T15:37:23Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31847ProSBC:Cloud:AWS Installation-B2022-07-29T15:34:38Z<p>Miguel Celis Salgado: /* Instantiate a ProSBC */</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Launch the FreeSBC/ProSBC image.<br />
[[File:EC2 launch AMI.png|900px|thumb|center]]<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
[[File:EC2 AMI CPU.png|900px|thumb|center]]<br />
<br />
<br />
* In "Network Settings" proceed to "Create a new security group". We recommend that you simply open all ports on your own IP addresses, since the SBC contains its own internal firewall:<br />
[[File:EC2 AMI Network.png|900px|thumb|center]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall, note that SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_Network.png&diff=31846File:EC2 AMI Network.png2022-07-29T15:23:06Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI_Network</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_AMI_CPU.png&diff=31845File:EC2 AMI CPU.png2022-07-29T15:07:12Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI_CPU</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:EC2_launch_AMI.png&diff=31844File:EC2 launch AMI.png2022-07-29T14:53:33Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_launch_AMI</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31843ProSBC:Cloud:AWS Installation-B2022-07-29T14:43:28Z<p>Miguel Celis Salgado: /* Instantiate a ProSBC */</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Select the region matching the region of the ProSBC AMI you want to test. If you don't know it, try "Canada (Central)".<br />
<br />
[[File:RegionAMI.png| 700px]]<br />
<br />
* Select the image and click “Launch”:<br />
[[File:SelectAMI.png| 700px]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:SelectResources.png| 800px]]<br />
<br />
<br />
* Click “Add Storage” to proceed to the next page:<br />
[[File:ChooseSubnet.png| 1000px]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31842ProSBC:Cloud:AWS Installation-B2022-07-29T14:41:16Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]<br />
<br />
* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate ProSBC AMI:<br />
[[File:AWS EC2 AMIs.png|900px|thumb|center]]<br />
<br />
* Select the region matching the region of the ProSBC AMI you want to test. If you don't know it, try "Canada (Central)".<br />
<br />
[[File:RegionAMI.png| 700px]]<br />
<br />
* Select the image and click “Launch”:<br />
[[File:SelectAMI.png| 700px]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:SelectResources.png| 800px]]<br />
<br />
<br />
* Click “Add Storage” to proceed to the next page:<br />
[[File:ChooseSubnet.png| 1000px]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:AWS_EC2_AMIs.png&diff=31841File:AWS EC2 AMIs.png2022-07-29T14:40:17Z<p>Miguel Celis Salgado: </p>
<hr />
<div>AWS_EC2_AMIs</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:Dashboard_-_EC2_Management_Console_2022-07-28_16-28-03_2.png&diff=31840File:Dashboard - EC2 Management Console 2022-07-28 16-28-03 2.png2022-07-29T13:57:53Z<p>Miguel Celis Salgado: </p>
<hr />
<div>EC2_AMI</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=File:AWS_Management_Console_2022-07-28_16-27-37.png&diff=31839File:AWS Management Console 2022-07-28 16-27-37.png2022-07-29T13:13:15Z<p>Miguel Celis Salgado: </p>
<hr />
<div>AWS EC2 console</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=ProSBC:Cloud:AWS_Installation-B&diff=31838ProSBC:Cloud:AWS Installation-B2022-07-29T12:24:14Z<p>Miguel Celis Salgado: Created page with "{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}} This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on A..."</p>
<hr />
<div>{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}<br />
<br />
This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).<br />
<br />
== '''Instantiate a ProSBC''' ==<br />
* After logging in your Amazon account, click on “EC2” in the main AWS console:<br />
[[File:ConsoleEC2.png| 600px]]<br />
<br />
* On the left menu, click on “AMIs”:<br />
[[File:AMIs.png| 100px]]<br />
<br />
* Click on the filter drop list and select “Private image” to locate ProSBC AMI:<br />
[[File:PrivateImages.png| 500px]]<br />
<br />
* Select the region matching the region of the ProSBC AMI you want to test. If you don't know it, try "Canada (Central)".<br />
<br />
[[File:RegionAMI.png| 700px]]<br />
<br />
* Select the image and click “Launch”:<br />
[[File:SelectAMI.png| 700px]]<br />
<br />
<br />
* Select the instance type and its resources. The recommended instance type is:<br />
** m4.large (2 vCPU, 8 GiB)<br />
* Supported instance type are: <br />
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])<br />
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.<br />
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.<br />
{| cellpadding="5" border="1" class="wikitable"<br />
|-<br />
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions per second (call rate)<br />
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring<br />
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass<br />
|-<br />
| valign="top" | <br />
m4.large<br />
| valign="top" | <br />
2<br />
| valign="top" | <br />
50<br />
| valign="top" | <br />
400<br />
| valign="top" | <br />
32,000<br />
|-<br />
| valign="top" | <br />
m4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.xlarge<br />
| valign="top" | <br />
4<br />
| valign="top" | <br />
215<br />
| valign="top" | <br />
750<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
c4.2xlarge<br />
| valign="top" | <br />
8<br />
| valign="top" | <br />
575<br />
| valign="top" | <br />
2,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.4xlarge<br />
| valign="top" | <br />
16<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,000<br />
| valign="top" | <br />
60,000<br />
|-<br />
| valign="top" | <br />
m4.10xlarge<br />
| valign="top" | <br />
40<br />
| valign="top" | <br />
650<br />
| valign="top" | <br />
4,800<br />
| valign="top" | <br />
60,000<br />
|-<br />
|}<br />
<br />
<br />
[[File:SelectResources.png| 800px]]<br />
<br />
<br />
* Click “Add Storage” to proceed to the next page:<br />
[[File:ChooseSubnet.png| 1000px]]<br />
<br />
<br />
* Change the Volume Size to 40Gb.<br />
* Select "Volume Type": gp2<br />
* Check the box "Delete on Termination"<br />
* Click “Add Tags” to proceed to the next page.<br />
[[File:NextTag.png| 800px]]<br />
<br />
<br />
* You can leave the default parameters as they are. <br />
* Click “Configure Security Group” to proceed to the next page:<br />
[[File:NextSecurityGroup.png| 800px]]<br />
<br />
* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rule !! Type !! Port Range !! Source IP<br />
|-<br />
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)<br />
|}<br />
[[File:AddRule.png| 600px ]]<br />
<br />
<br />
* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:<br />
[[File:Launch.png| 1000px]]<br />
<br />
<br />
* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):<br />
[[File:DownloadKey.png| 800px]]<br />
<br />
<br />
* Click on “Launch Instances”:<br />
[[File:LaunchWithKey.png| 800px]]<br />
<br />
<br />
* You can view your instance by clicking on “View Instances”:<br />
[[File:ViewInstance.png| 800px]]<br />
<br />
<br />
* Select the instance you just created and feel free to give it a name: <br />
[[File:RenameInstance.png| 800px]]<br />
<br />
=== Optional: Elastic IP Creation section ===<br />
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":<br />
[[File:ElasticIP.png| 300px]]<br />
<br />
<br />
* Click on "Allocate IP". A new public IP will be generated by Amazon:<br />
[[File:AllocateIP.png| 600px]]<br />
<br />
<br />
* Click on "Close":<br />
[[File:NewIP.png| 600px]]<br />
<br />
=== Optional: Elastic IP association section ===<br />
<br />
* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:<br />
[[File:IPforInstance.png| 600px]]<br />
<br />
* Find the '''eth0''' network interface in the instance description:<br />
[[File:GetTheRightNetworkInterface.png| 1100px]]<br />
<br />
<br />
* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:<br />
[[File:InterfaceID.png| 1100px]]<br />
<br />
<br />
* Right-click on the selected Network Interface, then click "Associate Address":<br />
[[File:AssociateAddress.png| 800px]]<br />
<br />
<br />
* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":<br />
[[File:SelectAddress.png| 800px]]<br />
<br />
<br />
* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:<br />
[[File:Ready.png| 1100px]]<br />
<br />
== Enable SR-IOV enhanced networking ==<br />
It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.<br />
<br />
This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''<br />
<br />
There are two types of enhanced networking, we need the second one.<br />
<br />
1) Elastic Network Adapter (ENA)<br />
<br />
2) Intel 82599 Virtual Function (VF) interface<br />
<br />
===Install the AWS CLI===<br />
https://aws.amazon.com/cli/<br />
<br />
===Get security credentials for the command line===<br />
On the AWS web portal, click on your account name and choose "My Security Credentials"<br />
<br />
Expand the "Access keys" section<br />
<br />
Create a new key, you will need the AWSAccessKeyId and AWSSecretKey<br />
<br />
===Open a CLI and execute the aws cli commands===<br />
aws configure<br />
<br />
Paste the access key ID and key that you previously obtained along with your default region.<br />
<br />
===Show if the enhanced networking is enabled===<br />
Make sure to replace the example instance ID with your own AWS instance ID<br />
<br />
aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport<br />
<br />
Enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {<br />
"Value": "simple"<br />
}<br />
}<br />
<br />
Not enabled:<br />
{<br />
"InstanceId": "i-0123456789abcdef1",<br />
"SriovNetSupport": {}<br />
}<br />
<br />
To enable the sriov enhanced networking, first turn off the instance then do:<br />
<br />
aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple<br />
<br />
== Accessing the ProSBC ==<br />
=== Accessing the ProSBC web portal ===<br />
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: <br/> http://35.183.126.193:12358<br />
<br/> <br />
:You should get to the ProSBC Configuration Wizard <br/> <br />
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]<br />
<br/> <br />
<br />
Take note that it may take a while for the ProSBC system to make the Web Portal available (around 3-5 minutes).<br />
<br />
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.<br />
<br />
== Web Portal Initial Configuration ==<br />
Click on the following link to pursue installation from the web portal:<br />
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]<br />
<br />
== Troubleshooting ==<br />
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]<br />
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]<br />
[[Category:Revise on Major]]<br />
<br />
== External References ==<br />
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=User:Miguel_Celis_Salgado&diff=31837User:Miguel Celis Salgado2022-07-29T12:21:58Z<p>Miguel Celis Salgado: Created page with "Create a new pages using a ProSBC:Cloud:AWS Installation-B"</p>
<hr />
<div>Create a new pages using a [[ProSBC:Cloud:AWS Installation-B]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SS7&diff=31836SS72022-07-28T12:10:39Z<p>Miguel Celis Salgado: /* Maximum Capacity */</p>
<hr />
<div>[[Image:Ss7-protocol-stack.jpg|thumb|300px|Diagram of the SS7 stack]]<br />
SS7 is a signaling protocol which is used to set up and tear down phone calls. It also provides support for such functionality as local number portability, [[SMS|Short Messaging Service (SMS)]], [[Prepaid & postpaid calling|prepaid billing]] and number translation.<br />
<br />
The configuration of SS7 requires that the physical layer, through to the transport layer, and up to the application layer be configured. SS7 configuration involves configuring values for [[MTP2 Layer]], [[MTP3 Layer]], SCCP, and [[ISUP]].<br />
<br />
A conceptual illustration of the SS7 protocol stack is shown on the right. In the SS7 architecture, every layer has very specific task and responsibilities to provide to upper layers. Looking at the figure on the right, we see that an SS7 stack covers all levels of the OSI model from physical to application layer. Within this model, it is possible to replace one of more layers by another protocol as long as it provides the same functionalities. In a base call control application over a TDM network, the SS7 stack required would include layers [[MTP1 Layer]], MTP2, MTP3 and ISUP or TUP.<br />
<br />
It is worth pointing out that, by being layered in different functional groups, SS7 was built so that different nodes in the network don’t need to implement every portion of the protocol stack if they don’t require to.<br />
<br />
<br />
== TelcoBridges and SS7 ==<br />
TelcoBridges provides SS7 support with all of its media gateway, VAS development platform and monitoring devices. SS7 functionality is licensed separately and can be provided at initial purchase or added later on via a software [[Add/Change_Licenses|license upgrade]].<br />
<br />
SS7 signaling is configured once for the entire [[Tmedia]] or [[Tdev]] system. Any one Tdev unit is capable of running the entire SS7 signaling stack for all the Tdev units in a system.<br />
<br />
Systems developed using TelcoBridges hardware can support up to a maximum of 64 point codes. It is worth noting that a single point code can be used for 2 or more devices configured as a single system.<br />
<br />
[[High Availability|High availability]] (HA) has been designed into the architecture of the Tmedia product such that the failure of an SS7 stack on one Tmedia unit will be taken over by the SS7 stack of another Tmedia unit.<br />
<br />
<br />
Click for further information on:<br />
*[[MTP2:Specification|Supported MTP2 standards and variants]]<br />
*[[MTP3:Specification|Supported MTP3 standards and variants]]<br />
*[[ISUP:Specification|Supported ISUP standards and variants]]<br />
== Maximum Capacity ==<br />
{| cellpadding="5" border="1" class="wikitable" style="text-align: center"<br />
|-<br />
! !!Release!!MTP2<br>HSL!!MTP2<br>LSL!!MTP3<br>Networks!!MTP3<br>Links!!MTP3<br>Linksets!!OPC!!DPC<br>Routes!!ISUP<br>Networks!!ISUP<br>Userparts!!SCCP<br>Networks/<br>Userparts/<br>LSAPs!!TCAP<br>Userparts!!CIC Groups<br>ISUP stack!!CICs<br>ISUP stack !! MTP2 Link<br>redundancy !! MTP3<br>Redundancy !! ISUP<br>Redundancy !! M3UA<br>SAP<br />
|- <br />
| rowspan="4" | TMG800 <br />
| 2.2-2.7 || 2 || 64 || 8 || 64 || 64 || 64 || 128 || 8 || 8 || 8 || 8 || 300 || 512 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.8 || 2 || 64 || 8 || 64 || 256|| 64 || 256 || 8 || 8 || 8 || 8 || 300 || 512 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.9 || 2 || 64 || 8 || 64 || 256|| 64 || 512 || 8 || 8 || 8 || 8 || 300 || 512 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.9.112+<br/>3.0.139+|| 2 || 64 || 8 || 64 || 256|| 64 || 512 || 8 || 8 || 16 || 8 || 300 || 512 || Yes || N/A || N/A || 8<br />
|-<br />
| rowspan="4" | TMG3200 <br />
| 2.2-2.7 || 2 || 64 || 8 || 64 || 64 || 64 || 128 || 8 || 8 || 8 || 8 || 300 || 2048 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.8 || 2 || 64 || 8 || 64 || 256 || 64 || 256 || 8 || 8 || 8 || 8 || 300 || 2048 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.9 || 2 || 64 || 8 || 64 || 256 || 64 || 512 || 8 || 8 || 8 || 8 || 300 || 2048 || Yes || N/A || N/A || 8<br />
|-<br />
| 2.9.112+<br/>3.0.139+ || 2 || 64 || 8 || 64 || 256 || 64 || 512 || 8 || 8 || 16 || 8 || 300 || 2048 || Yes || N/A || N/A || 8<br />
|-<br />
| rowspan="4" | TMG7800<br />
| 2.2-2.7 || 32 <br/>(2/Tmedia) || 256 <br/>(64/Tmedia) || 8 || 256 <br/>(64/Tmedia)|| 256 || 64 || 128 || 8 || 8 || 8 || 8 || 300 || 30000 || Yes || Yes || Yes || 8 <br />
|-<br />
| 2.8 || 32 <br/>(2/Tmedia) || 512 <br/>(64/Tmedia) || 16 || 512 <br/>(64/Tmedia)|| 512 || 64 || 256 || 16 || 8 || 8 || 8 || 300 || 30000 || Yes || Yes || Yes || 16 <br />
|-<br />
| 2.9 || 32 <br/>(2/Tmedia) || 512 <br/>(64/Tmedia) || 16 || 512 <br/>(64/Tmedia)|| 512 || 64 || 512 || 16 || 8 || 8 || 8 || 300 || 30000 || Yes || Yes || Yes || 16<br />
|-<br />
| 2.9.112+<br/>3.0.139+|| 32 <br/>(2/Tmedia) || 512 <br/>(64/Tmedia) || 16 || 512 <br/>(64/Tmedia)|| 512 || 64 || 512 || 16 || 8 || 16 || 8 || 300 || 30000 || Yes || Yes || Yes || 16<br />
|}<br />
<br />
== Supported SS7 Link types ==<br />
Typically:<br />
* A Link<br />
* F Link<br />
The following types are also supported in some circumstances:<br />
* B/D Link<br />
* C Link<br />
* E Link<br />
<br />
== Configuration ==<br />
<br />
=== Configuration ===<br />
*[[Toolpack:Protocol_Stack_Settings_E#SS7 ISUP|Web Portal v3.2: SS7 Signaling]]<br />
*[[Toolpack:Protocol_Stack_Settings_D#SS7 ISUP|Web Portal v3.0: SS7 Signaling]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[Toolpack:Protocol_Stack_Settings_C#SS7 ISUP|Web Portal v2.10: SS7 Signaling]]<br />
*[[Toolpack:Protocol_Stack_Settings_B#SS7 ISUP|Web Portal v2.9: SS7 Signaling]]<br />
*[[Toolpack:Protocol_Stack_Settings_A#SS7 ISUP|Web Portal v2.8: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.7#SS7 ISUP|Web Portal v2.7: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.6#SS7 ISUP|Web Portal v2.6: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.5#Configuring SS7|Web Portal v2.5: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.4#SS7_Signaling|Web Portal v2.4: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.3#SS7_Signaling|Web Portal v2.3: SS7 Signaling]]<br />
*[[Web_Portal_Tutorial_Guide_v2.2#SS7_Signaling|Web Portal v2.2: SS7 Signaling]]<br />
</div><br />
<br />
== References ==<br />
*[http://en.wikipedia.org/wiki/Signaling_System_7 Wikipedia article]<br />
*[[Short history of SS7]]<br />
<br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31787SNMP2022-06-28T12:23:50Z<p>Miguel Celis Salgado: /* TB-MIB SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Per RFC3418 a ColdStart signifies that some configuration changes <b>may</b> have been made. However the TMG does not report Configuration changes via this OID. ColdStart is expected even when no changes have been made to the configuration. User should not be alerted, alarms should not be raised.<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| The TMG will resort to ColdStart in most cases as the configuration changes are not reported via this OID.<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=1 OR tbHaNp1FunctionalState=2, it is major.<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br/>'''unknown'''(100)<br/>'''notRunning'''(101)<br/>'''starting'''(102)<br/>'''ready'''(103)<br/>'''shuttingDown'''(104)<br/>'''goingManagement'''(105)<br/>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| All tbHaAppCurrentState states are alarms except 103<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br/>'''notPresent'''(0)<br/>'''active'''(1)<br/>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| Normal starting process of services will begin with tbHaAppHaCurrentState with value 0 (notPresent), going to Value 2 (standby) to finally Value 1 (active). Consider as an alarm if tbHaAppHaCurrentState of services stay consistently in others states different than 1, this applies for standalone and 1+1 systems.<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br/>tbClockType can be:<br/>'''none'''(1)<br/>'''osc'''(2)<br/>'''trunk'''(3)<br/>'''netRef1'''(4)<br/>'''netRef2'''(5)<br/>'''ptmc1'''(6)<br/>'''ptmc2'''(7)<br/>'''ct8a'''(8)<br/>'''ct8b'''(9)<br/>'''mbl'''(10)<br/>'''bits'''(11)<br/>'''ds3'''(12)<br/>'''sonetSdh'''(13)<br/>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br/>'''unqualified'''(0)<br/>'''beingQualified'''(1)<br/>'''qualified'''(2)<br/>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| When Object 'tbClockGrade=0' or 'tbClockGrade=1' <br/>Cleared by 'tbClockGrade=2' or 'tbClockGrade=3' <br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When <b>ALL OBJECTS</b> report tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br/>'''up'''(1)<br/>'''down'''(2)<br/>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2 OR tbH248MgcCurrentState=3<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br/>'''false'''(0)<br/>'''true'''(1)<br/>'''notSupported'''(2)<br/>'''unknown'''(3)<br/>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.2]]<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31786SNMP2022-06-28T12:21:56Z<p>Miguel Celis Salgado: /* TB-MIB SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Per RFC3418 a ColdStart signifies that some configuration changes <b>may</b> have been made. However the TMG does not report Configuration changes via this OID. ColdStart is expected even when no changes have been made to the configuration. User should not be alerted, alarms should not be raised.<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| The TMG will resort to ColdStart in most cases as the configuration changes are not reported via this OID.<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=1 OR tbHaNp1FunctionalState=2, it is major.<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br/>'''unknown'''(100)<br/>'''notRunning'''(101)<br/>'''starting'''(102)<br/>'''ready'''(103)<br/>'''shuttingDown'''(104)<br/>'''goingManagement'''(105)<br/>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| All tbHaAppCurrentState states are alarms except 103<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br/>'''notPresent'''(0)<br/>'''active'''(1)<br/>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| Normal starting process of services will begin with tbHaAppHaCurrentState with value 0 (notPresent), going to Value 2 (standby) to finally Value 1 (active). Consider as an alarm tbHaAppHaCurrentState of services in others states different than 1, this applies for standalone and 1+1 systems.<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br/>tbClockType can be:<br/>'''none'''(1)<br/>'''osc'''(2)<br/>'''trunk'''(3)<br/>'''netRef1'''(4)<br/>'''netRef2'''(5)<br/>'''ptmc1'''(6)<br/>'''ptmc2'''(7)<br/>'''ct8a'''(8)<br/>'''ct8b'''(9)<br/>'''mbl'''(10)<br/>'''bits'''(11)<br/>'''ds3'''(12)<br/>'''sonetSdh'''(13)<br/>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br/>'''unqualified'''(0)<br/>'''beingQualified'''(1)<br/>'''qualified'''(2)<br/>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| When Object 'tbClockGrade=0' or 'tbClockGrade=1' <br/>Cleared by 'tbClockGrade=2' or 'tbClockGrade=3' <br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When <b>ALL OBJECTS</b> report tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br/>'''no'''(0)<br/>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br/>'''up'''(1)<br/>'''down'''(2)<br/>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2 OR tbH248MgcCurrentState=3<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br/>'''false'''(0)<br/>'''true'''(1)<br/>'''notSupported'''(2)<br/>'''unknown'''(3)<br/>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.2]]<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31780SNMP2022-06-15T21:44:19Z<p>Miguel Celis Salgado: /* TB-MIB SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=1 OR tbHaNp1FunctionalState=2, it is major.<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| All tbHaAppCurrentState states are alarms except 103<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| Value 0 is an alarm only in 1+1 mode<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2 OR tbH248MgcCurrentState=3<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.2]]<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31778SNMP2022-06-14T20:47:01Z<p>Miguel Celis Salgado: /* SNMP traps */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31777SNMP2022-06-14T20:46:27Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31776SNMP2022-06-14T20:45:17Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap is important and should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Noncritical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31775SNMP2022-06-14T20:44:02Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap is important and should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| A notification that the agent has started running<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31774SNMP2022-06-14T20:39:19Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap is important and should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Reboot notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31773SNMP2022-06-14T20:38:03Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap is important and should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarm<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Restart notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31772SNMP2022-06-14T20:37:30Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, In certain conditions could be critical, this trap is important and should raise an alarm.<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| Transition from network interface Down state. Normal clear trap for linkDown notification alarms<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is loading, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| Notify some configuration changes, normally when the system is running, Not critical<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| Shutdown notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| Restart notification, should raise and alarm until nsNotifyStart cleared<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31771SNMP2022-06-14T19:20:58Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, bad indicator of interface health<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| __<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31770SNMP2022-06-14T19:15:58Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| When ifAdminStatus=1 & ifOperStatus=2, bad indicator of interface health<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31769SNMP2022-06-14T18:57:50Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31768SNMP2022-06-14T18:57:14Z<p>Miguel Celis Salgado: /* SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| { OID }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=SNMP&diff=31555SNMP2022-04-28T13:38:33Z<p>Miguel Celis Salgado: /* IF-MIB SNMP Trap/Notification */</p>
<hr />
<div>The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems. <br />
<br/><br/>For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].<br />
<br/><br />
== TelcoBridges and SNMP ==<br />
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). This grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]).<br><br />
<br/><br />
== Supported SNMP MIB modules ==<br />
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]<br />
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':<br />
#**ipRouteTable<br />
#**EGP group<br />
#**atTable <br />
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]<br />
#*The following tables are supported:<br />
#**ifTable<br />
#**ifStackTable <br />
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]<br />
#*The following tables of the DS1-MIB are supported:<br />
#**Dsx1ConfigTable<br />
#**Dsx1CurrentTable<br />
#**Dsx1IntervalTable<br />
#**Dsx1TotalTable<br />
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]<br />
#*The following tables of the DS3-MIB are supported:<br />
#**Dsx3ConfigTable<br />
#**Dsx3CurrentTable<br />
#**Dsx3IntervalTable<br />
#**Dsx3TotalTable<br />
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]<br />
#*The following tables of the SONET-MIB are supported: <br />
#**sonetMediumTable<br />
#**sonetSectionCurrentTable<br />
#**sonetSectionIntervalTable<br />
#**sonetLineCurrentTable<br />
#**sonetLineIntervalTable<br />
#**sonetFarendLineCurrentTable<br />
#**sonetFarendLineIntervalTable<br />
#**sonetPathCurrentTable<br />
#**sonetPathIntervalTable<br />
#**sonetFarendPathCurrentTable<br />
#**sonetFarendPathIntervalTable<br />
#**sonetVtCurrentTable<br />
#**sonetVtIntervalTable<br />
#**sonetFarendVtCurrentTable<br />
#**sonetFarendVtIntervalTable<br />
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]<br />
#*The following tables of the ISDN-MIB are supported:<br />
#**isdnBearerGroup<br />
#**isdnSignalingGroup<br />
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]<br />
#*tbHwCommon<br />
#**tbHwIdentTable (Hardware Identification)<br />
#**tbHwVersionTable (Hardware Version)<br />
#**tbHwTempTable (Hardware Temperature)<br />
#**tbHwPowerSupplyTable (Hardware Power Supply)<br />
#**tbHwFanTable (Hardware Fan)<br />
#*tbSwCommon<br />
#**tbFeatureTable (Software Features Supported) <br />
#**tbSwVersionTable (Software Version)<br />
#**tbSwPerfTable (CPU Usage)<br />
#*tbSignaling<br />
#**tbMtp2<br />
#**tbM2pa<br />
#**tbM2ua<br />
#**tbM3ua<br />
#**tbIua<br />
#**tbIsdn<br />
#**tbCas<br />
#**tbSip<br />
#**tbH248<br />
#*tbCalls<br />
#*tbNAP<br />
#*tbHaNp1<br />
#*tbHaApp<br />
#*tbClock<br />
<br />
=== SNMP IF-MIB ifTable interface type ===<br />
The following table provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! IANA ifType <br />
! TelcoBridges Interface description<br />
|-<br />
| ethernetCsmacd(6)<br />
| Baseboard Ethernet interfaces <br />
|-<br />
| ds1(18)<br />
| Trunks Line Interface<br />
|-<br />
| ds3(30)<br />
| DS3 Line Interface<br />
|-<br />
| sonet(39)<br />
| SONET/SDH Line Interface<br />
|-<br />
| sonetPath(50)<br />
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)<br />
|-<br />
| sonetVT(51)<br />
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)<br />
|-<br />
| isdn(63)<br />
| ISDN Stack<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Primary)<br />
|-<br />
| lapd(77)<br />
| ISDN LAPD Link (Backup)<br />
|-<br />
| isdn(63)<br />
| IUA Link<br />
|-<br />
| isdn(63)<br />
| IUA Peer<br />
|-<br />
| lapd(77)<br />
| LAPD Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2PA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Link<br />
|-<br />
| ss7SigLink (156)<br />
| SS7 M2UA Peer<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Sap<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psp<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 M3ua Psrv<br />
|-<br />
| ss7SigLink (156)<br />
| Ss7 Mtp2 Link<br />
|}<br />
<br />
=== SNMP traps ===<br />
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[SNMP#Configuration|SNMP configuration]].<br />
<br />
====SNMP Trap/Notification====<br />
<br />
{| cellpadding="0" border="0" style="width: 1200px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! MIB<br />
! OID<br />
! OBJECTS<br />
! RFC<br />
! RELEASE<br />
|-<br />
| linkDown<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.3<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| linkUp<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.4<br />
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }<br />
| RFC1573<br />
| 2.8+<br />
|-<br />
| ColdStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.1<br />
| { OID }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| WarmStart<br />
| IF-MIB<br />
| 1.3.6.1.6.3.1.1.5.2<br />
| { OID }<br />
| RFC3418<br />
| 3.2+<br />
|-<br />
| nsNotifyStart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.1<br />
| { OID }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyShutdown<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.2<br />
| { OID }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|-<br />
| nsNotifyRestart<br />
| NET-SNMP-MIB<br />
| 1.3.6.1.4.1.8072.4.0.3<br />
| { OID }<br />
| (see www.net-snmp.org)<br />
| 3.2+<br />
|}<br />
<br />
====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====<br />
<br />
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"<br />
|-<br />
! Trap Name <br />
! Details<br />
! OID<br />
! OBJECTS<br />
! CONSIDERED AS AN ALARM<br />
! RELEASE<br />
|-<br />
| tbNapAvailability<br />
| The network access point has a new percentage of availability for calls<br />
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type.<br/><br />
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network.<br/><br />
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.1<br />
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }<br />
| When tbNapAvailablePercent=0<br />
| 2.8+<br />
|-<br />
| tbPwrSupplyState<br />
| The redundant power supply has a new state.<br/><br/>tbHwPwrSupplyStatus can be: <br/>'''good'''(0)<br/>'''failure'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.2<br />
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }<br />
| When tbHwPwrSupplyStatus=1<br />
| 2.8+<br />
|-<br />
| tbNp1State<br />
| The N+1 patch panel has a new state.<br/><br/>tbHaNp1FunctionalState can be: <br/>'''unknown'''(-1)<br/>'''fault'''(0): There is no access to the N+1 patch panel<br/>'''unprotected'''(1): Standby unit is not available<br/>'''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over<br/>'''healthy'''(3): N+1 unit is normal and standby unit is available<br/>'''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.3<br />
| { tbHaNp1Name, tbHaNp1FunctionalState }<br />
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2<br />
| 2.8+<br />
|-<br />
| tbAppState<br />
| This toolpack application has a new state.<br/><br/>tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.4<br />
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }<br />
| When tbHaAppCurrentState=106<br />
| 2.8+<br />
|-<br />
| tbAppHaState<br />
| This toolpack high availability application has changed state.<br/><br/>tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.5<br />
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkGradeState<br />
| The network synchronization clock from this interface has a new grade.<br/><br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14)<br/><br/>tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.6<br />
| { tbClockName, tbClockType, tbClockGrade }<br />
| '''__'''<br />
| 2.8+<br />
|-<br />
| tbClkActiveState<br />
| This interface has been selected or not to provide the network synchronization clock for the whole system.<br/><br/>tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.7<br />
| { tbClockName, tbClockType, tbClockActive }<br />
| When tbClockActive=0<br />
| 2.8+<br />
|-<br />
| tbIsdnDChannelState<br />
| The signaling channel for this ISDN interface has changed.<br/><br/>tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.8<br />
| { tbIsdnDescription, tbIsdnDChannelUp }<br />
| When tbIsdnDChannelUp=0<br />
| 2.8+<br />
|-<br />
| tbCASPhysicalLineState<br />
| The interface for this CAS stack has changed.<br/><br/>tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.9<br />
| { tbCasDescription, tbCasPhysicalLineUp }<br />
| When tbCasPhysicalLineUp=0<br />
| 2.8+<br />
|-<br />
| tbSipState<br />
| The SIP stack state has changed.<br/><br/>tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.10<br />
| { tbSipDescription, tbSipCurrentState }<br />
| When tbSipCurrentState=0<br />
| 2.8+<br />
|-<br />
| tbH248MgcState<br />
| The H.248 communication state between this unit and the Media Gateway Controller has changed.<br/><br/>tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.11<br />
| { tbH248MgcName, tbH248MgcCurrentState }<br />
| When tbH248MgcCurrentState=2<br />
| 2.8+<br />
|-<br />
| tbHostUpdateAvailableState<br />
| The availability state of the host update has changed.<br/><br/>tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)<br />
| 1.3.6.1.4.1.21776.1.1.2.1.0.12<br />
| { tbHostName, tbHostUpdateAvailable }<br />
| '''__'''<br />
| 2.8+<br />
|}<br />
<br />
<br>Example of packet capture:<br />
tcpdump port 162 -i mgmt0 -s 0<br />
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode<br />
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes<br />
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4<br />
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1 <br />
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10<br />
<br />
== Note ==<br />
The '''ifIndex''' is a random value that can change after configuring the system, or adding new elements. This should not be relied on as a reference value. Please use the '''ifDescr''' instead.<br />
<br />
=== SNMP SET ===<br />
The '''SNMP SET''' command is not supported by TelcoBridges products. However, a [[Northbound_interface:RESTful|RESTful API]] can be used to change the configuration remotely.<br />
<br />
<br/><br />
<br />
== Configuration ==<br />
<br />
*[[Toolpack:System_Settings_D#SNMP|Configuring SNMP for version 3.0]]<br />
*[[Toolpack:System_Settings_C#SNMP|Configuring SNMP for version 2.10]]<br />
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]<br />
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]<br />
*[[ProSBC:Zabbix configuration with Telcobridges products|Zabbix Configuration]]<br />
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;"><br />
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]<br />
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack systems previous to 2.5.80''':<br />
*[[Installing NetSNMP from an External Host]]<br />
*[[TMG SNMP support|How to relay SNMP on TMG products]]<br />
<br />
<br/><br />
</div><br />
<br />
== Helpful resources ==<br />
*[[Npp_tools|Notepad ++ tools for SNMP]]<br />
<br />
== External Sources ==<br />
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]<br />
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]<br />
<br/><br/> <br />
<br />
[[Category:Glossary]]<br />
[[Category:Revise on Major]]</div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=Sbc_Tutorial_Guide_v3.1&diff=31554Sbc Tutorial Guide v3.12022-04-28T03:16:35Z<p>Miguel Celis Salgado: /* IP Network */</p>
<hr />
<div>{{DISPLAYTITLE:FreeSBC/ProSBC 3.1 Web Portal Tutorial Guide}}<br />
<br />
__NOTOC__<br />
'''Introduction'''<br />
The Web Portal Tutorial provides you with a scenario-based approach to configuring and monitoring the status of [[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] systems, using the Web Portal configuration tool. Complete general installation configuration steps, before you begin configuring your specific application.<br />
<br />
'''Prerequisites'''<br />
[[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] devices must be installed as described in their respective [[Product_Installation_SBC|installation guides]].<br />
<br />
'''Web Portal Categories'''<br />
Web Portal configuration and status topics are grouped into the following major categories. It is recommended that you follow this order.<br />
<br />
=System= <br />
*Host Role<br />
*SBC<br />
*Access and User Management<br />
*Database Backup<br />
*SNMP<br />
*Configuration<br />
*Minor Package Upgrade<br />
*Software Licenses<br />
*Statistics<br />
*Audit Logs<br />
[[Toolpack:Tsbc System Settings 3.1|(Configuration)]]<br />
<br />
=IP Network= <br />
{{#ev:youtube|https://www.youtube.com/watch?v=cKPz95CjNYY&t=4926s|720|right}}<br />
<br />
<br />
<br />
<br />
<br />
<br />
*IP Network<br />
*DNS<br />
*NAT<br />
*Transcoding Units<br />
*Ethernet Bonding<br />
[[Toolpack:Tsbc IP Network Settings 3.1|(Configuration)]]<br />
<br />
=Protocol Stack= <br />
*Certificates and TLS Profiles <br />
*SIP<br />
*Calls<br />
*NAP<br />
[[Toolpack:Tsbc_Protocol_Stack_Settings_3.1|(Configuration)]]<br />
<br />
=CDR= <br />
*Text CDR<br />
*RADIUS <br />
[[Toolpack:Tsbc_CDR_Settings_3.1|(Configuration)]] <br />
<br />
=Fax=<br />
*FAX passthrough (silence suppression) <br />
*FAX T.38<br />
*FAX passthrough (NSE) <br />
*FAX passthrough (VBD) <br />
[[Toolpack:Tsbc_Fax_Settings_3.1|(Configuration)]]<br />
<br />
=Call Route= <br />
{{#ev:youtube|https://www.youtube.com/watch?v=NqOnTEQxju8&t=2848s|720|right}}<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
*Static Route<br />
*Routing Script<br />
*Label Routing<br />
*RADIUS Authorization and Authentication<br />
[[Toolpack:Tsbc_Call Routes_Settings_3.1|(Configuration)]]<br />
<br />
=Lawful Intercept=<br />
[[Toolpack:Tsbc Lawful Interception 3.1|(Configuration)]] [[(Status)]]<br />
<br />
=Troubleshooting= <br />
*CallTrace<br />
*Test Call<br />
*Target Recording<br />
*Ethernet Capture<br />
[[Toolpack:Tsbc Troubleshooting 3.1|(Configuration)]]<br />
<br />
<br />
[[category:Toolpack]]<br />
<br />
<headertabs/></div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=Sbc_Tutorial_Guide_v3.1&diff=31553Sbc Tutorial Guide v3.12022-04-28T03:12:22Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:FreeSBC/ProSBC 3.1 Web Portal Tutorial Guide}}<br />
<br />
__NOTOC__<br />
'''Introduction'''<br />
The Web Portal Tutorial provides you with a scenario-based approach to configuring and monitoring the status of [[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] systems, using the Web Portal configuration tool. Complete general installation configuration steps, before you begin configuring your specific application.<br />
<br />
'''Prerequisites'''<br />
[[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] devices must be installed as described in their respective [[Product_Installation_SBC|installation guides]].<br />
<br />
'''Web Portal Categories'''<br />
Web Portal configuration and status topics are grouped into the following major categories. It is recommended that you follow this order.<br />
<br />
=System= <br />
*Host Role<br />
*SBC<br />
*Access and User Management<br />
*Database Backup<br />
*SNMP<br />
*Configuration<br />
*Minor Package Upgrade<br />
*Software Licenses<br />
*Statistics<br />
*Audit Logs<br />
[[Toolpack:Tsbc System Settings 3.1|(Configuration)]]<br />
<br />
=IP Network= <br />
*IP Network<br />
*DNS<br />
*NAT<br />
*Transcoding Units<br />
*Ethernet Bonding<br />
[[Toolpack:Tsbc IP Network Settings 3.1|(Configuration)]]<br />
<br />
=Protocol Stack= <br />
*Certificates and TLS Profiles <br />
*SIP<br />
*Calls<br />
*NAP<br />
[[Toolpack:Tsbc_Protocol_Stack_Settings_3.1|(Configuration)]]<br />
<br />
=CDR= <br />
*Text CDR<br />
*RADIUS <br />
[[Toolpack:Tsbc_CDR_Settings_3.1|(Configuration)]] <br />
<br />
=Fax=<br />
*FAX passthrough (silence suppression) <br />
*FAX T.38<br />
*FAX passthrough (NSE) <br />
*FAX passthrough (VBD) <br />
[[Toolpack:Tsbc_Fax_Settings_3.1|(Configuration)]]<br />
<br />
=Call Route= <br />
{{#ev:youtube|https://www.youtube.com/watch?v=NqOnTEQxju8&t=2848s|720|right}}<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
*Static Route<br />
*Routing Script<br />
*Label Routing<br />
*RADIUS Authorization and Authentication<br />
[[Toolpack:Tsbc_Call Routes_Settings_3.1|(Configuration)]]<br />
<br />
=Lawful Intercept=<br />
[[Toolpack:Tsbc Lawful Interception 3.1|(Configuration)]] [[(Status)]]<br />
<br />
=Troubleshooting= <br />
*CallTrace<br />
*Test Call<br />
*Target Recording<br />
*Ethernet Capture<br />
[[Toolpack:Tsbc Troubleshooting 3.1|(Configuration)]]<br />
<br />
<br />
[[category:Toolpack]]<br />
<br />
<headertabs/></div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=Sbc_Tutorial_Guide_v3.1&diff=31552Sbc Tutorial Guide v3.12022-04-28T03:11:53Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:FreeSBC/ProSBC 3.1 Web Portal Tutorial Guide}}<br />
<br />
__NOTOC__<br />
'''Introduction'''<br />
The Web Portal Tutorial provides you with a scenario-based approach to configuring and monitoring the status of [[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] systems, using the Web Portal configuration tool. Complete general installation configuration steps, before you begin configuring your specific application.<br />
<br />
'''Prerequisites'''<br />
[[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] devices must be installed as described in their respective [[Product_Installation_SBC|installation guides]].<br />
<br />
'''Web Portal Categories'''<br />
Web Portal configuration and status topics are grouped into the following major categories. It is recommended that you follow this order.<br />
<br />
=System= <br />
*Host Role<br />
*SBC<br />
*Access and User Management<br />
*Database Backup<br />
*SNMP<br />
*Configuration<br />
*Minor Package Upgrade<br />
*Software Licenses<br />
*Statistics<br />
*Audit Logs<br />
[[Toolpack:Tsbc System Settings 3.1|(Configuration)]]<br />
<br />
=IP Network= <br />
*IP Network<br />
*DNS<br />
*NAT<br />
*Transcoding Units<br />
*Ethernet Bonding<br />
[[Toolpack:Tsbc IP Network Settings 3.1|(Configuration)]]<br />
<br />
=Protocol Stack= <br />
*Certificates and TLS Profiles <br />
*SIP<br />
*Calls<br />
*NAP<br />
[[Toolpack:Tsbc_Protocol_Stack_Settings_3.1|(Configuration)]]<br />
<br />
=CDR= <br />
*Text CDR<br />
*RADIUS <br />
[[Toolpack:Tsbc_CDR_Settings_3.1|(Configuration)]] <br />
<br />
=Fax=<br />
*FAX passthrough (silence suppression) <br />
*FAX T.38<br />
*FAX passthrough (NSE) <br />
*FAX passthrough (VBD) <br />
[[Toolpack:Tsbc_Fax_Settings_3.1|(Configuration)]]<br />
<br />
=Call Route= <br />
{{#ev:youtube|https://www.youtube.com/watch?v=NqOnTEQxju8&t=2848s|720|right}}<br />
<br />
<br />
<br />
<br />
<br />
*Static Route<br />
*Routing Script<br />
*Label Routing<br />
*RADIUS Authorization and Authentication<br />
[[Toolpack:Tsbc_Call Routes_Settings_3.1|(Configuration)]]<br />
<br />
=Lawful Intercept=<br />
[[Toolpack:Tsbc Lawful Interception 3.1|(Configuration)]] [[(Status)]]<br />
<br />
=Troubleshooting= <br />
*CallTrace<br />
*Test Call<br />
*Target Recording<br />
*Ethernet Capture<br />
[[Toolpack:Tsbc Troubleshooting 3.1|(Configuration)]]<br />
<br />
<br />
[[category:Toolpack]]<br />
<br />
<headertabs/></div>Miguel Celis Salgadohttps://docs.telcobridges.com/w/index.php?title=Sbc_Tutorial_Guide_v3.1&diff=31551Sbc Tutorial Guide v3.12022-04-28T03:09:20Z<p>Miguel Celis Salgado: </p>
<hr />
<div>{{DISPLAYTITLE:FreeSBC/ProSBC 3.1 Web Portal Tutorial Guide}}<br />
<br />
__NOTOC__<br />
'''Introduction'''<br />
The Web Portal Tutorial provides you with a scenario-based approach to configuring and monitoring the status of [[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] systems, using the Web Portal configuration tool. Complete general installation configuration steps, before you begin configuring your specific application.<br />
<br />
'''Prerequisites'''<br />
[[FreeSBC|FreeSBC]]/[[ProSBC|ProSBC]] devices must be installed as described in their respective [[Product_Installation_SBC|installation guides]].<br />
<br />
'''Web Portal Categories'''<br />
Web Portal configuration and status topics are grouped into the following major categories. It is recommended that you follow this order.<br />
<br />
=System= <br />
*Host Role<br />
*SBC<br />
*Access and User Management<br />
*Database Backup<br />
*SNMP<br />
*Configuration<br />
*Minor Package Upgrade<br />
*Software Licenses<br />
*Statistics<br />
*Audit Logs<br />
[[Toolpack:Tsbc System Settings 3.1|(Configuration)]]<br />
<br />
=IP Network= <br />
*IP Network<br />
*DNS<br />
*NAT<br />
*Transcoding Units<br />
*Ethernet Bonding<br />
[[Toolpack:Tsbc IP Network Settings 3.1|(Configuration)]]<br />
<br />
=Protocol Stack= <br />
*Certificates and TLS Profiles <br />
*SIP<br />
*Calls<br />
*NAP<br />
[[Toolpack:Tsbc_Protocol_Stack_Settings_3.1|(Configuration)]]<br />
<br />
=CDR= <br />
*Text CDR<br />
*RADIUS <br />
[[Toolpack:Tsbc_CDR_Settings_3.1|(Configuration)]] <br />
<br />
=Fax=<br />
*FAX passthrough (silence suppression) <br />
*FAX T.38<br />
*FAX passthrough (NSE) <br />
*FAX passthrough (VBD) <br />
[[Toolpack:Tsbc_Fax_Settings_3.1|(Configuration)]]<br />
<br />
=Call Route= <br />
{{#ev:youtube|https://www.youtube.com/watch?v=NqOnTEQxju8&t=2848s|720|right}}<br />
*Static Route<br />
*Routing Script<br />
*Label Routing<br />
*RADIUS Authorization and Authentication<br />
[[Toolpack:Tsbc_Call Routes_Settings_3.1|(Configuration)]]<br />
<br />
=Lawful Intercept=<br />
[[Toolpack:Tsbc Lawful Interception 3.1|(Configuration)]] [[(Status)]]<br />
<br />
=Troubleshooting= <br />
*CallTrace<br />
*Test Call<br />
*Target Recording<br />
*Ethernet Capture<br />
[[Toolpack:Tsbc Troubleshooting 3.1|(Configuration)]]<br />
<br />
<br />
[[category:Toolpack]]<br />
<br />
<headertabs/></div>Miguel Celis Salgado