swagger: '2.0'
info:
  description: Configuration for SNMP User resource.
  version: 'v2'
  title: snmp_user
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: snmp_user
    description: SNMP User
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: name
   in: path
   type: string
   description: Name of SNMP User
   required: true
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/snmp_user:
    get:
      tags:
        - snmp_user
      summary: GET all snmp_user
      operationId: getall_snmp_user
      description: Use this operation to get SNMP User details
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the snmp_user resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the snmp_user resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of snmp_user resources.
          enum:
            - yes
      responses:
        200:
          description:  for snmp_user
          schema: 
              $ref: '#/definitions/getsnmp_usersResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    post:
      tags:
        - snmp_user
      summary: POST operation for snmp_user
      operationId: post_snmp_user
      description: POST operation for snmp_user
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: snmp_user
          description: snmp_user object
          schema:
              $ref: '#/definitions/addsnmp_userRequest'
      responses:
        200:
          description: add for snmp_user
          schema: 
              $ref: '#/definitions/addsnmp_userResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/config/snmp_user/{name}:
    get:
      tags:
        - snmp_user
      summary: GET by key for snmp_user
      operationId: getbykey_snmp_user
      description: Use this operation to get SNMP User details
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        200:
          description: add for snmp_user
          schema: 
              $ref: '#/definitions/getsnmp_userResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    put:
      tags:
        - snmp_user
      summary: PUT for snmp_user
      operationId: putbykey_snmp_user
      description: Use this operation to modify SNMP User
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: body
          name: snmp_user
          description: snmp_user object
          schema:
              $ref: '#/definitions/modifysnmp_userRequest'
      responses:
        200:
          description: add for snmp_user
          schema: 
              $ref: '#/definitions/modifysnmp_userResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    delete:
      tags:
        - snmp_user
      summary: Delete for snmp_user
      operationId: deletebykey_snmp_user
      description: Use this operation to delete SNMP User
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        204:
          description: add for snmp_user
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  addsnmp_userRequest:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        $ref: '#/definitions/snmp_user_readwrite'
    title: addsnmp_userRequest
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"

  addsnmp_userResponse:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        $ref: '#/definitions/snmp_user'
    title: addsnmp_userResponse
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        name: "cpuUsageHigh"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"
        security_level_str: "string_value"
        privacy_protocol_str: "string_value"
        auth_protocol_str: "string_value"

  getsnmp_userResponse:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        $ref: '#/definitions/snmp_user'
    title: getsnmp_userResponse
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        name: "cpuUsageHigh"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"
        security_level_str: "string_value"
        privacy_protocol_str: "string_value"
        auth_protocol_str: "string_value"

  getsnmp_usersResponse:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        type: array
        items:
          $ref: '#/definitions/snmp_user'
    title: getsnmp_usersResponse
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        name: "cpuUsageHigh"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"
        security_level_str: "string_value"
        privacy_protocol_str: "string_value"
        auth_protocol_str: "string_value"

  modifysnmp_userRequest:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        $ref: '#/definitions/snmp_user_readwrite'
    title: modifysnmp_userRequest
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"

  modifysnmp_userResponse:
    type: object
    required:
      - snmp_user
    properties:
      snmp_user:
        $ref: '#/definitions/snmp_user'
    title: modifysnmp_userResponse
    example:
      snmp_user:
        security_level: "0"
        auth_password: "string_value"
        privacy_protocol: "0"
        name: "cpuUsageHigh"
        privacy_password: "string_value"
        view_name: "string_value"
        auth_protocol: "0"
        security_level_str: "string_value"
        privacy_protocol_str: "string_value"
        auth_protocol_str: "string_value"

  snmp_user_readwrite:
    type: object
    properties:
      security_level:
        description: "Security Level of SNMP User. Values: 0: noAuthNoPriv, 1: authNoPriv, 2: authPriv"
        type: integer
        format: int32
      auth_password:
        description: "Authentication Password of SNMP User"
        type: string
        format: password
        minLength: 8
        maxLength: 32
      privacy_protocol:
        description: "Privacy Protocol of SNMP User. Values: 0:noValue, 1: DES, 2: AES"
        type: integer
        format: int32
      privacy_password:
        description: "Privacy Password of SNMP User"
        type: string
        format: password
        minLength: 8
        maxLength: 32
      view_name:
        description: "SNMP View Name attached to the SNMP User"
        type: string
        format: string
        maxLength: 32
      auth_protocol:
        description: "Authentication Protocol of SNMP User. Values: 0:noValue, 1: MD5, 2: SHA1"
        type: integer
        format: int32

  snmp_user:
    allOf:
      -
        properties:
          name:
            description: Name of SNMP User
            type: string
            format: string
      - $ref: '#/definitions/snmp_user_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
