swagger: '2.0'
info:
  description: Configuration for Citrix SD-WAN WO SNMP Configuration resource.
  version: 'v2'
  title: cbwanopt_snmp_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: cbwanopt_snmp_config
    description: Citrix SD-WAN WO SNMP Configuration
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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/cbwanopt_snmp_config:
    get:
      tags:
        - cbwanopt_snmp_config
      summary: GET all cbwanopt_snmp_config
      operationId: getall_cbwanopt_snmp_config
      description: Use this operation to get snmp configuration
      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 cbwanopt_snmp_config 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 cbwanopt_snmp_config 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 cbwanopt_snmp_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for cbwanopt_snmp_config
          schema: 
              $ref: '#/definitions/getcbwanopt_snmp_configsResponse'
        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:
        - cbwanopt_snmp_config
      summary: POST operation for cbwanopt_snmp_config
      operationId: post_cbwanopt_snmp_config
      description: POST operation for cbwanopt_snmp_config
      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: cbwanopt_snmp_config
          description: cbwanopt_snmp_config object
          schema:
              $ref: '#/definitions/addcbwanopt_snmp_configRequest'
      responses:
        200:
          description: add for cbwanopt_snmp_config
          schema: 
              $ref: '#/definitions/addcbwanopt_snmp_configResponse'
        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:
  addcbwanopt_snmp_configRequest:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        $ref: '#/definitions/cbwanopt_snmp_config_readwrite'
    title: addcbwanopt_snmp_configRequest
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  addcbwanopt_snmp_configResponse:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        $ref: '#/definitions/cbwanopt_snmp_config'
    title: addcbwanopt_snmp_configResponse
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  getcbwanopt_snmp_configResponse:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        $ref: '#/definitions/cbwanopt_snmp_config'
    title: getcbwanopt_snmp_configResponse
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  getcbwanopt_snmp_configsResponse:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        type: array
        items:
          $ref: '#/definitions/cbwanopt_snmp_config'
    title: getcbwanopt_snmp_configsResponse
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  modifycbwanopt_snmp_configRequest:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        $ref: '#/definitions/cbwanopt_snmp_config_readwrite'
    title: modifycbwanopt_snmp_configRequest
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  modifycbwanopt_snmp_configResponse:
    type: object
    required:
      - cbwanopt_snmp_config
    properties:
      cbwanopt_snmp_config:
        $ref: '#/definitions/cbwanopt_snmp_config'
    title: modifycbwanopt_snmp_configResponse
    example:
      cbwanopt_snmp_config:
        trapdestination: "10.40.40.20"
        cbwanopt_ip_address: "10.102.40.60"
        state: "enable"

  cbwanopt_snmp_config_readwrite:
    type: object
    properties:
      trapdestination:
        description: "Trapdestination of IP ADDRESS"
        type: string
        format: ipaddress
      cbwanopt_ip_address:
        description: "Citrix SD-WANOpt IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      state:
        description: "State of configuration (enable/disable)"
        type: string
        format: string

  cbwanopt_snmp_config:
    allOf:
      - $ref: '#/definitions/cbwanopt_snmp_config_readwrite'

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