NSX-T Data Center REST API

CCSnmpV3User (type)

{
  "additionalProperties": false,
  "description": "This object contains properties for a SNMP V3 user that can be used to receive SNMP traps/notifications from NSX and/or poll NSX nodes over SNMP.",
  "id": "CCSnmpV3User",
  "module_id": "CentralConfig",
  "properties": {
    "access": {
      "default": "READ_ONLY",
      "description": "Access permissions for polling NSX nodes over SNMP V3.",
      "enum": [
        "READ_ONLY"
      ],
      "title": "Type of access",
      "type": "string"
    },
    "auth_password": {
      "description": "Authentication password used for SNMP V3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for authentication password.",
      "required": false,
      "sensitive": true,
      "title": "Authentication password",
      "type": "secure_string"
    },
    "priv_password": {
      "description": "Privacy password used for SNMP V3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for privacy password.",
      "required": false,
      "sensitive": true,
      "title": "Privacy password",
      "type": "secure_string"
    },
    "security_level": {
      "default": "AUTH_PRIV",
      "description": "Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.",
      "enum": [
        "AUTH_PRIV"
      ],
      "title": "Security level",
      "type": "string"
    },
    "user_id": {
      "description": "Unique SNMP V3 user id.",
      "maxLength": 32,
      "minLength": 1,
      "required": true,
      "title": "User ID",
      "type": "string"
    }
  },
  "title": "SNMP V3 user",
  "type": "object"
}