Configuring SNMP in Gaia Portal

For detailed information, see sk90860: How to configure SNMP on Gaia OS.

Important - On Scalable Platforms (ElasticXL, Maestro, and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

Select Enable SNMP Agent.

3

In the Version drop down list, select the version of SNMP to run:

  • 1/v2/v3 (any)

    Select this option if your SNMP management station does not support SNMPv3.

  • v3-Only

    Select this option if your SNMP management station supports v3.

    SNMPv3 provides a higher level of security than v1 or v2.

4

In SNMP Location String, enter a string that contains the location for the system.

The maximum length for the string is 128 characters.

That includes letters, numbers, spaces, special characters

For example: Bldg 1, Floor 3, WAN Lab, Fast Networks, Speedy, CA

5

In SNMP Contact String, enter a string that contains the contact information for the device.

The maximum length for the string is 128 characters.

That includes letters, numbers, spaces, special characters.

For example: John Doe, Network Administrator, (111) 222‑3333

6

Click Apply.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

The SNMP Addresses table shows the applicable interfaces and their IP addresses.

2

By default, all interfaces are selected. You can select the individual interfaces.

Note - If you do not specify agent addresses, the SNMP protocol responds to requests from all interfaces.

Step

Instructions

1

In the V1/V2 Settings section, in Read Only Community String, set a string other than public.

You must always use this is a basic security precaution.

2

Optional.

Set a Read-Write Community String.

Warning - Set a read-write community string only if you have reason to enable set operations, and if your network is secure.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the V3 - User-Based Security Model (USM) section, click Add.

The Add New USM User window opens.

3

In the User Name, enter the applicable user name.

This can be the same as a user name for system access.

Notes:

  • This string must contain alphanumeric characters with no spaces, backslash, or colon characters.

  • The length of this string is between 1 and 31 characters on Management Server, Log Servers, and Security Gateways that run in the Gateway mode with MDPS disabled.

  • The length of this string is between 1 and 26 characters on Security Gateways that run in the VSX mode or with MDPS enabled.

4

In the Security Level, select one of these options from the drop-down list:

  • authPriv - The user has authentication and privacy pass phrases and can connect with privacy encryption.

  • authNoPriv - The user has only an authentication pass phrase and can connect only without privacy encryption.

5

In the User Permissions, select one of these options from the drop-down list:

  • read-only

  • read-write

6

In the Authentication Protocol, select one of these options from the drop-down list:

  • SHA256

  • SHA512

The default is SHA512.

Note - When you change the configured Authentication Protocol of an existing SNMPv3 USM user, Gaia OS requires you to change the Authentication Pass Phrase because the previous password is not valid anymore.

7

In the Authentication Pass Phrase, enter a password for the user that is between 8 and 128 characters in length.

8

In the Privacy Protocol, select:

  • DES

  • AES

  • AES256

The default is DES.

Note - When you change the configured Privacy Protocol of an existing SNMPv3 USM user, Gaia OS requires you to change the Privacy Pass Phrase because the previous password is not valid anymore.

9

In the Privacy Pass Phrase, enter a pass phrase that is between 8 and 128 characters in length.

Used for protection against disclosure of SNMP message payloads.

10

Click Save.

The new user shows in the table.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the V3 - User-Based Security Model (USM) section, select the user and click Edit.

The Edit USM User window opens.

3

You can change the Security Level, User Permissions, the Authentication Protocol, the Authentication Passphrase, or the Privacy Protocol.

4

Click Save.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the V3 - User-Based Security Model (USM) section, select the user and click Remove.

The Deleting USM User Entry window opens.

3

The window shows this message:

Are you sure you want to delete "username" entry?.

Click Yes.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Enabled Traps section, click Set.

The Add New Trap Receiver window opens.

  • To enable a trap:

    Select it from the Disabled Traps list, and click Add>

  • To disable a trap:

    Select it from the Enabled Traps list, and click Remove>

3

Click Save.

4

Add a USM user.

You must do this even if you use only SNMPv1 or SNMPv2.

In the Trap User, select an SNMP user.

5

In Polling Frequency, specify the number of seconds between polls.

6

Click Apply.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Trap Receivers Settings section, click Add.

The Add New Trap Receiver window opens.

3

In the IPv4 Address, enter the IP address of an SNMP receiver.

4

In the Version, select the SNMP Version for the specified receiver.

5

In the Community String, enter the SNMP community string for the specified receiver.

6

Click Save.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Trap Receivers Settings section, select the SNMP receiver and click Edit.

The Edit Trap Receiver window opens.

3

You can change the SNMP version or the SNMP community string.

4

Click Save.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Trap Receivers Settings section, select the SNMP trap receiver and click Remove.

The Deleting Trap Receiver Entry window opens.

3

The window shows this message: Are you sure you want to delete "IPv4 address" entry?

Click Yes.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Custom Traps section, click Add.

The Add New Custom Trap window opens.

3

In the Trap Name, enter the name of an SNMP trap.

Range: 1 - 128 characters.

4

In the OID, enter the SNMP OID to query.

  • The OID value can contain only numbers and periods (sub-identifiers separated by periods).

  • The OID value can contain from 2 to 128 sub-identifiers:

    from X.X to X.X.(124 sub-identifiers more)

  • Number range of each sub-identifier: 0 - 4294967295.

  • The first sub-identifier must be one of these numbers:

    • 0

      In this case, the second sub-identifier must be between 0-39:

      0.<0-39>.(other applicable sub-identifiers)

    • 1

      In this case, the second sub-identifier must be between 0-39:

      1.<0-39>.(other applicable sub-identifiers)

    • 2

      2.X.(other applicable sub-identifiers)

5

In the Operator field, select the applicable operator to examine the value the SNMP OID to query returns:

  • Equal - The returned value is equal to the value in the Threshold field.

  • Not_Equal - The returned value is not equal to the value in the Threshold field.

  • Less_Than - The returned value is less than the value in the Threshold field.

  • Greater_Than - The returned value is greater than the value in the Threshold field.

  • Changed - The returned value is different than the returned value in the previous SNMP OID query.

6

In the Threshold, enter an integer value to which Gaia operating system compares the value returned in the SNMP OID query.

Range: 1 - 128 characters.

7

In the Frequency, enter the interval (in seconds) between the SNMP OID queries.

Range: 1 - 4294967295.

8

In the Message, enter the applicable text.

This is the message you get in the SNMP Trap packets the Gaia operating system sends.

Range: 1 - 128 characters.

9

Click Save.

For explanations, see the section "Adding a custom SNMP trap".

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Custom Traps section, select the custom SNMP trap and click Edit.

The Edit Custom Trap window opens.

3

Configure the applicable settings.

6

Click Save.

Step

Instructions

1

In the navigation tree, click System Management > SNMP.

2

In the Custom Traps section, select the custom SNMP trap and click Remove.

3

The window shows this message: Are you sure you want to delete "<Name of Custom Trap>" entry?

Click Yes.

See the R82 Scalable Platforms Administration Guide.