{
  "id": "net-snmp",
  "name": "Net-SNMP",
  "homepage": "https://www.net-snmp.org",
  "description": "A suite of applications for using and deploying SNMP.",
  "executables": [
    "snmpget",
    "snmpwalk",
    "snmpset",
    "snmptranslate",
    "snmpconf"
  ],
  "dotfiles": {
    "paths": [
      "~/.snmp/snmp.conf",
      "~/.snmp/hosts/"
    ],
    "secret": [],
    "secret_paths": [
      {
        "file": "~/.snmp/snmp.conf",
        "match": {
          "prefix": [
            "defCommunity",
            "defAuthPassphrase",
            "defPrivPassphrase"
          ]
        }
      }
    ]
  },
  "commands": {
    "format": 1,
    "label": "Query an SNMP agent (snmpget)",
    "description": "Fetch one or more OIDs from an SNMP agent with snmpget. SNMPv3 engine IDs, MIB parsing and debug options are not in this form; passphrases typed here appear in the command line.",
    "quality": "ai-draft",
    "parser": {
      "end_of_options": "--",
      "interleave": "permute",
      "long_equals": false,
      "short_attached": true,
      "short_bundles": false
    },
    "source": [
      {
        "id": "help",
        "kind": "help",
        "revision": "snmpget 5.6.2.1 --help",
        "evidence": "USAGE: snmpget [OPTIONS] AGENT OID [OID]...\n  -v 1|2c|3\t\tspecifies SNMP version to use\n  -c COMMUNITY\t\tset the community string\n  -a PROTOCOL\t\tset authentication protocol (MD5|SHA)\n  -A PASSPHRASE\t\tset authentication protocol pass phrase\n  -l LEVEL\t\tset security level (noAuthNoPriv|authNoPriv|authPriv)\n  -u USER-NAME\t\tset security name (e.g. bert)\n  -x PROTOCOL\t\tset privacy protocol (DES|AES)\n  -X PASSPHRASE\t\tset privacy protocol pass phrase\n  -r RETRIES\t\tset the number of retries\n  -t TIMEOUT\t\tset the request timeout (in seconds)\n  -m MIB[:...]\t\tload given list of MIBs (ALL loads everything)\n\t\t\t  n:  print OIDs numerically\n\t\t\t  v:  print values only (not OID = value)\n  -O OUTOPTS\t\tToggle various defaults controlling output display:\n"
      }
    ],
    "field": [
      {
        "id": "agent",
        "label": "Agent host",
        "type": "string",
        "position": 0,
        "sources": [
          "help"
        ]
      },
      {
        "id": "oids",
        "label": "OIDs",
        "type": "string",
        "position": 1,
        "multiple": true,
        "sources": [
          "help"
        ]
      },
      {
        "id": "version",
        "label": "SNMP version",
        "type": "enum",
        "choices": [
          {
            "value": "1",
            "label": "v1"
          },
          {
            "value": "2c",
            "label": "v2c"
          },
          {
            "value": "3",
            "label": "v3"
          }
        ],
        "option": [
          "-v"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "community",
        "label": "Community (v1/v2c)",
        "type": "string",
        "option": [
          "-c"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "user",
        "label": "Security name (v3)",
        "type": "string",
        "option": [
          "-u"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "level",
        "label": "Security level (v3)",
        "type": "enum",
        "choices": [
          {
            "value": "noAuthNoPriv",
            "label": "noAuthNoPriv"
          },
          {
            "value": "authNoPriv",
            "label": "authNoPriv"
          },
          {
            "value": "authPriv",
            "label": "authPriv"
          }
        ],
        "option": [
          "-l"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "auth_protocol",
        "label": "Auth protocol (v3)",
        "type": "enum",
        "choices": [
          {
            "value": "MD5",
            "label": "MD5"
          },
          {
            "value": "SHA",
            "label": "SHA"
          }
        ],
        "option": [
          "-a"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "auth_pass",
        "label": "Auth passphrase (v3)",
        "type": "string",
        "option": [
          "-A"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "priv_protocol",
        "label": "Privacy protocol (v3)",
        "type": "enum",
        "choices": [
          {
            "value": "DES",
            "label": "DES"
          },
          {
            "value": "AES",
            "label": "AES"
          }
        ],
        "option": [
          "-x"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "priv_pass",
        "label": "Privacy passphrase (v3)",
        "type": "string",
        "option": [
          "-X"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "retries",
        "label": "Retries",
        "type": "integer",
        "option": [
          "-r"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "timeout",
        "label": "Timeout (seconds)",
        "type": "integer",
        "option": [
          "-t"
        ],
        "sources": [
          "help"
        ]
      },
      {
        "id": "output",
        "label": "Output options",
        "description": "Letters after -O, for example n (numeric OIDs), v (values only).",
        "type": "string",
        "option": [
          "-O"
        ],
        "suggestions": [
          {
            "value": "n",
            "label": "Numeric OIDs"
          },
          {
            "value": "v",
            "label": "Values only"
          }
        ],
        "sources": [
          "help"
        ]
      }
    ],
    "task": [
      {
        "id": "v2c",
        "label": "Get OIDs with v2c",
        "fields": [
          "agent",
          "oids",
          "version",
          "community"
        ],
        "required": [
          "agent",
          "oids",
          "version",
          "community"
        ],
        "set": {
          "version": [
            "2c"
          ]
        }
      },
      {
        "id": "v3",
        "label": "Get OIDs with v3",
        "fields": [
          "agent",
          "oids",
          "version",
          "user",
          "level",
          "auth_protocol",
          "auth_pass",
          "priv_protocol",
          "priv_pass"
        ],
        "required": [
          "agent",
          "oids",
          "version",
          "user",
          "level"
        ],
        "set": {
          "version": [
            "3"
          ]
        }
      }
    ],
    "group": [
      {
        "id": "basic",
        "label": "Basic",
        "fields": [
          "agent",
          "oids",
          "version",
          "community"
        ]
      },
      {
        "id": "advanced",
        "label": "SNMPv3 and tuning",
        "fields": [
          "user",
          "level",
          "auth_protocol",
          "auth_pass",
          "priv_protocol",
          "priv_pass",
          "retries",
          "timeout",
          "output"
        ]
      }
    ]
  }
}