swagger: '2.0'
info:
  description: Configuration for NetScaler Syslog Configure Task resource.
  version: 'v2'
  title: sdx_syslog_template
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: sdx_syslog_template
    description: NetScaler Syslog Configure Task
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/sdx_syslog_template:
    get:
      tags:
        - sdx_syslog_template
      summary: GET all sdx_syslog_template
      operationId: getall_sdx_syslog_template
      description: Use this operation to get sdx syslog servers
      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 sdx_syslog_template 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 sdx_syslog_template 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 sdx_syslog_template resources.
          enum:
            - yes
      responses:
        200:
          description:  for sdx_syslog_template
          schema: 
              $ref: '#/definitions/getsdx_syslog_templatesResponse'
        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:
  getsdx_syslog_templateResponse:
    type: object
    required:
      - sdx_syslog_template
    properties:
      sdx_syslog_template:
        $ref: '#/definitions/sdx_syslog_template'
    title: getsdx_syslog_templateResponse
    example:
      sdx_syslog_template:
        scheduleTimesEpoch: "1581031800"
        device_groups: "[devgrp1, devgrp2]"
        scheduleTimes: "string_value"
        name: "ns_nsroot_profile"
        variables: [{        device_values_mapping: "string_value"
,        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        on_error: "string_value"
        port: "514"
        execute_sequentially: "boolean_value"
        tz_offset: "0"
        scheduleOptions: "string_value"
        devices: "[1.1.1.1, 1.1.1.2]"
        scheduleType: "string_value"
        ip_address: "1.1.1.1"

  getsdx_syslog_templatesResponse:
    type: object
    required:
      - sdx_syslog_template
    properties:
      sdx_syslog_template:
        type: array
        items:
          $ref: '#/definitions/sdx_syslog_template'
    title: getsdx_syslog_templatesResponse
    example:
      sdx_syslog_template:
        scheduleTimesEpoch: "1581031800"
        device_groups: "[devgrp1, devgrp2]"
        scheduleTimes: "string_value"
        name: "ns_nsroot_profile"
        variables: [{        device_values_mapping: "string_value"
,        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        on_error: "string_value"
        port: "514"
        execute_sequentially: "boolean_value"
        tz_offset: "0"
        scheduleOptions: "string_value"
        devices: "[1.1.1.1, 1.1.1.2]"
        scheduleType: "string_value"
        ip_address: "1.1.1.1"

  sdx_syslog_template_readwrite:
    type: object
    properties:
      scheduleTimesEpoch:
        description: "Schedule time epoch (string representation of 11 digit numbers)."
        type: string
        format: string
      device_groups:
        description: "Device Group Array on which for which template is applied"
        type: array
        items:
          type: string
          format: string
      scheduleTimes:
        description: "Comma separated times of the day(HH:MM) on which Configuration Template is scheduled"
        type: string
        format: string
      name:
        description: "Name of Syslog Server"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      variables:
        type: array
        items:
          $ref: '#/definitions/variable_values_readwrite'
      port:
        description: "Syslog server port"
        type: integer
        format: int32
      execute_sequentially:
        description: "True if configuration template is to be applied to devices sequentially"
        type: boolean
        format: boolean
      tz_offset:
        description: "Time zone offset."
        type: integer
        format: int32
      scheduleOptions:
        description: "Comma separated Options for scheduling Configuration Template"
        type: string
        format: string
      devices:
        description: "Device IP Address Array on which template is applied"
        type: array
        items:
          type: string
          format: ipaddress
      scheduleType:
        description: "Schedule Type of Configuration Template that is scheduled"
        type: string
        format: string
      ip_address:
        description: "Syslog server IP address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64

  sdx_syslog_template:
    allOf:
      - $ref: '#/definitions/sdx_syslog_template_readwrite'

  variable_values_readwrite:
    type: object
    properties:
      parent_name:
        type: string
        format: string
      value:
        description: "Value of the Variable to be used for all device ips/groups"
        type: string
        format: string
      name:
        description: "Variable name"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      valuex:
        description: "Secure Value of the Variable to be used for all device ips/groups"
        type: string
        format: password
      display_name:
        description: "Display name of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      description:
        description: "Description of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      device_values:
        type: array
        items:
          $ref: '#/definitions/device_values_map_readwrite'
      parent_id:
        type: string
        format: string
      default_value:
        description: "Default Value of configuration variable"
        type: string
        format: string
      type:
        description: "Type of Variable"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      values_enum_db:
        description: "Comma separated list of possible values of variable"
        type: string
        format: string

  variable_values:
    allOf:
      -
        properties:
          id:
            type: string
            format: string
      - $ref: '#/definitions/variable_values_readwrite'

  device_values_map_readwrite:
    type: object
    properties:
      value:
        description: "Value of the Variable to be used for device ip/group"
        type: string
        format: string
      valuex:
        description: "Secure Value of the Variable to be used for device ip/group"
        type: string
        format: password
      device_group:
        description: "Device Group for which value is to be defined"
        type: string
        format: string
      device:
        description: "IP Address for this device"
        type: string
        format: ipaddress

  device_values_map:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the device value mapping
            type: string
            format: uuid
          parent_name:
             description: "Parent Name"
             type: string
             format: string
          parent_id:
             description: "Parent ID"
             type: string
             format: uuid
      - $ref: '#/definitions/device_values_map_readwrite'

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