|
| 1 | +.. _cp_gaia_snmp_module: |
| 2 | + |
| 3 | + |
| 4 | +cp_gaia_snmp -- SNMP agent configuration. |
| 5 | +========================================= |
| 6 | + |
| 7 | +.. contents:: |
| 8 | + :local: |
| 9 | + :depth: 1 |
| 10 | + |
| 11 | + |
| 12 | +Synopsis |
| 13 | +-------- |
| 14 | + |
| 15 | +SNMP agent configuration. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +Requirements |
| 20 | +------------ |
| 21 | +The below requirements are needed on the host that executes this module. |
| 22 | + |
| 23 | +- supported starting from gaia\_api \>= 1.6 |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +Parameters |
| 28 | +---------- |
| 29 | + |
| 30 | + version (False, str, None) |
| 31 | + Gaia API version for example 1.6. |
| 32 | + |
| 33 | + |
| 34 | + enabled (False, bool, None) |
| 35 | + Enables/Disables the SNMP Agent. |
| 36 | + |
| 37 | + |
| 38 | + ver (False, str, None) |
| 39 | + Configures the supported SNMP version v1, v2 and v3. |
| 40 | + |
| 41 | + |
| 42 | + trap_usm (False, str, None) |
| 43 | + The user which will generate the SNMP traps, should be existed usm user |
| 44 | + |
| 45 | + |
| 46 | + contact (False, str, None) |
| 47 | + SNMP contact string |
| 48 | + |
| 49 | + |
| 50 | + location (False, str, None) |
| 51 | + SNMP location string Specifies a string that contains the location for the device. |
| 52 | + |
| 53 | + |
| 54 | + read_only_community (False, str, None) |
| 55 | + SNMP read-only community password, Where read-only lets you only read the values of SNMP objects |
| 56 | + |
| 57 | + |
| 58 | + read_write_community (False, str, None) |
| 59 | + SNMP read-write community password, Where read-write read and set the values as well |
| 60 | + |
| 61 | + |
| 62 | + interfaces (False, str, None) |
| 63 | + Adds a local interface to the list of local interfaces, on which the SNMP daemon listens |
| 64 | + |
| 65 | + |
| 66 | + pre_defined_traps_settings (optional, dict, None) |
| 67 | + Pre-defined traps settings. |
| 68 | + |
| 69 | + |
| 70 | + custom_traps_settings (optional, dict, None) |
| 71 | + Custom traps settings. |
| 72 | + |
| 73 | + |
| 74 | + vsx_settings (optional, dict, None) |
| 75 | + VSX settings. |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | +Notes |
| 82 | +----- |
| 83 | + |
| 84 | +.. note:: |
| 85 | + - Supports \ :literal:`check\_mode`\ . |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | +Examples |
| 91 | +-------- |
| 92 | + |
| 93 | +.. code-block:: yaml+jinja |
| 94 | + |
| 95 | + |
| 96 | + - name: Set SNMP status |
| 97 | + check_point.gaia.cp_gaia_snmp: |
| 98 | + enabled: true |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | + |
| 103 | +Return Values |
| 104 | +------------- |
| 105 | + |
| 106 | +snmp (always., dict, ) |
| 107 | + The checkpoint object updated. |
| 108 | + |
| 109 | + |
| 110 | + |
| 111 | + |
| 112 | + |
| 113 | +Status |
| 114 | +------ |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | +Authors |
| 121 | +~~~~~~~ |
| 122 | + |
| 123 | +- Ameer Asli (@chkp-ameera) |
| 124 | + |
0 commit comments