swagger: '2.0'
info:
  description: Configuration for NetScaler Syslog Config resource.
  version: 'v2'
  title: ns_syslog_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_syslog_config
    description: NetScaler Syslog Config
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: ns_ip_address
   in: path
   type: string
   description: NetScaler IP Address
   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/ns_syslog_config:
    get:
      tags:
        - ns_syslog_config
      summary: GET all ns_syslog_config
      operationId: getall_ns_syslog_config
      description: Get the syslog server configuration for NetScaler
      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 ns_syslog_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 ns_syslog_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 ns_syslog_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_syslog_config
          schema: 
              $ref: '#/definitions/getns_syslog_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'

  /massvc/{customerid}/nitro/v2/config/ns_syslog_config/{ns_ip_address}:
    get:
      tags:
        - ns_syslog_config
      summary: GET by key for ns_syslog_config
      operationId: getbykey_ns_syslog_config
      description: Get the syslog server configuration for NetScaler
      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:  for ns_syslog_config
          schema: 
              $ref: '#/definitions/getns_syslog_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'

    put:
      tags:
        - ns_syslog_config
      summary: PUT for ns_syslog_config
      operationId: putbykey_ns_syslog_config
      description: Use this operation to modify syslog server configuration
      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: ns_syslog_config
          description: ns_syslog_config object
          schema:
              $ref: '#/definitions/modifyns_syslog_configRequest'
      responses:
        200:
          description:  for ns_syslog_config
          schema: 
              $ref: '#/definitions/modifyns_syslog_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:
  getns_syslog_configResponse:
    type: object
    required:
      - ns_syslog_config
    properties:
      ns_syslog_config:
        $ref: '#/definitions/ns_syslog_config'
    title: getns_syslog_configResponse
    example:
      ns_syslog_config:
        informational: "false"
        alert: "false"
        none: "false"
        all: "false"
        facility: "string_value"
        state: "ENABLED"
        ns_ip_address: "1.1.1.1"
        notice: "false"
        destination_ip: "1.1.1.1"
        critical: "false"
        emergency: "false"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        warning: "false"
        error: "false"
        debug: "false"

  getns_syslog_configsResponse:
    type: object
    required:
      - ns_syslog_config
    properties:
      ns_syslog_config:
        type: array
        items:
          $ref: '#/definitions/ns_syslog_config'
    title: getns_syslog_configsResponse
    example:
      ns_syslog_config:
        informational: "false"
        alert: "false"
        none: "false"
        all: "false"
        facility: "string_value"
        state: "ENABLED"
        ns_ip_address: "1.1.1.1"
        notice: "false"
        destination_ip: "1.1.1.1"
        critical: "false"
        emergency: "false"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        warning: "false"
        error: "false"
        debug: "false"

  modifyns_syslog_configRequest:
    type: object
    required:
      - ns_syslog_config
    properties:
      ns_syslog_config:
        $ref: '#/definitions/ns_syslog_config_readwrite'
    title: modifyns_syslog_configRequest
    example:
      ns_syslog_config:
        informational: "false"
        alert: "false"
        none: "false"
        all: "false"
        facility: "string_value"
        state: "ENABLED"
        notice: "false"
        destination_ip: "1.1.1.1"
        critical: "false"
        emergency: "false"
        warning: "false"
        error: "false"
        debug: "false"

  modifyns_syslog_configResponse:
    type: object
    required:
      - ns_syslog_config
    properties:
      ns_syslog_config:
        $ref: '#/definitions/ns_syslog_config'
    title: modifyns_syslog_configResponse
    example:
      ns_syslog_config:
        informational: "false"
        alert: "false"
        none: "false"
        all: "false"
        facility: "string_value"
        state: "ENABLED"
        ns_ip_address: "1.1.1.1"
        notice: "false"
        destination_ip: "1.1.1.1"
        critical: "false"
        emergency: "false"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        warning: "false"
        error: "false"
        debug: "false"

  ns_syslog_config_readwrite:
    type: object
    properties:
      informational:
        description: "Enable informational"
        type: boolean
        format: boolean
      alert:
        description: "Enable alert"
        type: boolean
        format: boolean
      none:
        description: "Enable none"
        type: boolean
        format: boolean
      all:
        description: "Enable all"
        type: boolean
        format: boolean
      facility:
        description: "Facility"
        type: string
        format: string
      state:
        description: "Syslog Status"
        type: string
        format: string
      notice:
        description: "Enable notice"
        type: boolean
        format: boolean
      destination_ip:
        description: "Syslog Destination IP Address"
        type: string
        format: ipaddress
      critical:
        description: "Enable critical"
        type: boolean
        format: boolean
      emergency:
        description: "Enable emergency"
        type: boolean
        format: boolean
      warning:
        description: "Enable warning"
        type: boolean
        format: boolean
      error:
        description: "Enable error"
        type: boolean
        format: boolean
      debug:
        description: "Enable debug"
        type: boolean
        format: boolean

  ns_syslog_config:
    allOf:
      -
        properties:
          ns_ip_address:
            description: NetScaler IP Address
            type: string
            format: ipaddress
          act_id:
             description: "Activity Id"
             type: string
             format: uuid
      - $ref: '#/definitions/ns_syslog_config_readwrite'

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