Resource URL: /platform/<<version=3>>/protocols/snmp/settings

    Overview: This resource represents configuration for SNMP.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve the SNMP settings.

       URL: GET /platform/<<version=3>>/protocols/snmp/settings

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "settings": {
      "type": "object", 
      "description": "SNMP settings.", 
      "properties": {
        "read_only_community": {
          "minLength": 1, 
          "type": "string", 
          "description": "The read-only community name.  @DEFAULT reverts this field to its default value."
        }, 
        "service": {
          "type": "boolean", 
          "description": "Whether the SNMP service is enabled."
        }, 
        "system_contact": {
          "minLength": 1, 
          "type": "string", 
          "description": "Contact information for the system owner.  This must be a valid email address.  @DEFAULT reverts this field to its default value.", 
          "pattern": "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,4}$"
        }, 
        "snmp_v1_v2c_access": {
          "type": "boolean", 
          "description": "Whether SNMP v1 and v2c protocols are enabled.  @DEFAULT reverts this field to its default value."
        }, 
        "snmp_v3_read_only_user": {
          "minLength": 1, 
          "type": "string", 
          "description": "The read-only user for SNMP v3 read requests.  @DEFAULT reverts this field to its default value."
        }, 
        "system_location": {
          "minLength": 1, 
          "type": "string", 
          "description": "A location name for the SNMP system.  @DEFAULT reverts this field to its default value."
        }, 
        "snmp_v3_access": {
          "type": "boolean", 
          "description": "Whether SNMP v3 is enabled.  @DEFAULT reverts this field to its default value."
        }
      }
    }
  }
}

********************************************************************************

Method PUT: Modify the SNMO settings. All input fields are optional, but one or
            more must be supplied.

       URL: PUT /platform/<<version=3>>/protocols/snmp/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "SNMP settings.", 
  "properties": {
    "read_only_community": {
      "minLength": 1, 
      "type": "string", 
      "description": "The read-only community name.  @DEFAULT reverts this field to its default value."
    }, 
    "service": {
      "type": "boolean", 
      "description": "Whether the SNMP service is enabled."
    }, 
    "system_contact": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 1, 
          "type": "string", 
          "description": "Contact information for the system owner.  This must be a valid email address.  @DEFAULT reverts this field to its default value.", 
          "pattern": "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,4}$"
        }
      ]
    }, 
    "snmp_v1_v2c_access": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Whether SNMP v1 and v2c protocols are enabled.  @DEFAULT reverts this field to its default value."
        }
      ]
    }, 
    "snmp_v3_read_only_user": {
      "minLength": 1, 
      "type": "string", 
      "description": "The read-only user for SNMP v3 read requests.  @DEFAULT reverts this field to its default value."
    }, 
    "snmp_v3_password": {
      "minLength": 8, 
      "type": "string", 
      "description": "This field allows a client to change the SNMP v3 password. There is always a password set.  @DEFAULT reverts this field to its default value.", 
      "maxLength": 39
    }, 
    "system_location": {
      "minLength": 1, 
      "type": "string", 
      "description": "A location name for the SNMP system.  @DEFAULT reverts this field to its default value."
    }, 
    "snmp_v3_access": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Whether SNMP v3 is enabled.  @DEFAULT reverts this field to its default value."
        }
      ]
    }
  }
}

There is no response body for this method.
