swagger: '2.0'
info:
  description: Configuration for NetScaler Service Group Information resource.
  version: 'v2'
  title: ns_servicegroup
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_servicegroup
    description: NetScaler Service Group Information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key
   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_servicegroup:
    get:
      tags:
        - ns_servicegroup
      summary: GET all ns_servicegroup
      operationId: getall_ns_servicegroup
      description: Use this operation to get Service Group Information
      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_servicegroup 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_servicegroup 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_servicegroup resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_servicegroup
          schema: 
              $ref: '#/definitions/getns_servicegroupsResponse'
        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_servicegroup/{id}:
    get:
      tags:
        - ns_servicegroup
      summary: GET by key for ns_servicegroup
      operationId: getbykey_ns_servicegroup
      description: Use this operation to get Service Group Information
      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_servicegroup
          schema: 
              $ref: '#/definitions/getns_servicegroupResponse'
        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:
        - ns_servicegroup
      summary: POST operation with actions for ns_servicegroup
      operationId: post_ns_servicegroup_actions
      description: POST operation with actions for ns_servicegroup
      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: query
          name: action
          type: string
          required: true
          enum: [enable,poll,disable]
          description: >
            actions:
              * `enable` - Use this operation to enable the service group
              * `poll` - Use this operation to poll the service group
              * `disable` - Use this operation to disable the service group

        - in: body
          name: ns_servicegroup
          description: ns_servicegroup object
          schema:
              $ref: '#/definitions/addns_servicegroupRequest'
      responses:
        200:
          description: disable for ns_servicegroup
          schema: 
              $ref: '#/definitions/addns_servicegroupResponse'
        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:
  addns_servicegroupRequest:
    type: object
    required:
      - ns_servicegroup
    properties:
      ns_servicegroup:
        $ref: '#/definitions/ns_servicegroup_readwrite'
    title: addns_servicegroupRequest
    example:
      ns_servicegroup:
        appflowlog: "ENABLED"
        hostname: "Hostname"
        svc_grp_mem_port: "80"
        svc_grp_name: "servicegroup1"
        ns_ip_address: "1.1.1.1"
        svc_grp_mem_ip_address: "1.1.1.1"
        save_config: "true"
        lb_id: "string_value"
        vsvr_name: "string_value"
        svr_name: "server_name"
        delay: "0"
        svr_id: "string_value"
        graceful: "boolean_value"

  addns_servicegroupResponse:
    type: object
    required:
      - ns_servicegroup
    properties:
      ns_servicegroup:
        $ref: '#/definitions/ns_servicegroup'
    title: addns_servicegroupResponse
    example:
      ns_servicegroup:
        svrstate: "UP"
        appflowlog: "ENABLED"
        hostname: "Hostname"
        svc_grp_state_timestamp: "number_value"
        svc_grp_mem_port: "80"
        svc_grp_name: "servicegroup1"
        poll_time: "1580714461"
        display_name: "displayname"
        svc_grp_effective_state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        comment: "comments"
        svc_grp_mem_ip_address: "1.1.1.1"
        svc_grp_mem_state: "UP"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        customer_name: "admTenant"
        svc_grp_mem_type: "HTTP"
        save_config: "true"
        lb_id: "string_value"
        vsvr_name: "string_value"
        svr_name: "server_name"
        delay: "0"
        svr_id: "string_value"
        graceful: "boolean_value"

  getns_servicegroupResponse:
    type: object
    required:
      - ns_servicegroup
    properties:
      ns_servicegroup:
        $ref: '#/definitions/ns_servicegroup'
    title: getns_servicegroupResponse
    example:
      ns_servicegroup:
        svrstate: "UP"
        appflowlog: "ENABLED"
        hostname: "Hostname"
        svc_grp_state_timestamp: "number_value"
        svc_grp_mem_port: "80"
        svc_grp_name: "servicegroup1"
        poll_time: "1580714461"
        display_name: "displayname"
        svc_grp_effective_state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        comment: "comments"
        svc_grp_mem_ip_address: "1.1.1.1"
        svc_grp_mem_state: "UP"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        customer_name: "admTenant"
        svc_grp_mem_type: "HTTP"
        save_config: "true"
        lb_id: "string_value"
        vsvr_name: "string_value"
        svr_name: "server_name"
        delay: "0"
        svr_id: "string_value"
        graceful: "boolean_value"

  getns_servicegroupsResponse:
    type: object
    required:
      - ns_servicegroup
    properties:
      ns_servicegroup:
        type: array
        items:
          $ref: '#/definitions/ns_servicegroup'
    title: getns_servicegroupsResponse
    example:
      ns_servicegroup:
        svrstate: "UP"
        appflowlog: "ENABLED"
        hostname: "Hostname"
        svc_grp_state_timestamp: "number_value"
        svc_grp_mem_port: "80"
        svc_grp_name: "servicegroup1"
        poll_time: "1580714461"
        display_name: "displayname"
        svc_grp_effective_state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        comment: "comments"
        svc_grp_mem_ip_address: "1.1.1.1"
        svc_grp_mem_state: "UP"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        customer_name: "admTenant"
        svc_grp_mem_type: "HTTP"
        save_config: "true"
        lb_id: "string_value"
        vsvr_name: "string_value"
        svr_name: "server_name"
        delay: "0"
        svr_id: "string_value"
        graceful: "boolean_value"

  ns_servicegroup_readwrite:
    type: object
    properties:
      appflowlog:
        description: "AppFlow is enabled at servicegroup of LBVServer"
        type: string
        format: string
      hostname:
        description: "Hostname of the managed device"
        type: string
        format: string
        minLength: 1
        maxLength: 256
      svc_grp_mem_port:
        description: "Service Group Member Port"
        type: integer
        format: int32
      svc_grp_name:
        description: "Service Group Name"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      svc_grp_mem_ip_address:
        description: "Service Group Member IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      save_config:
        description: "Save configuration after enable/disable"
        type: boolean
        format: boolean
      lb_id:
        description: "LB ID"
        type: string
        format: string
      vsvr_name:
        description: "Vserver Name"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      svr_name:
        description: "Server Member Name"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      delay:
        description: "Time, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service"
        type: number
        format: double
      svr_id:
        description: "Server ID"
        type: string
        format: string
      graceful:
        description: "Graceful shutdown of Service."
        type: boolean
        format: boolean

  ns_servicegroup:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: uuid
          svrstate:
             description: "Service State"
             type: string
             format: string
          display_name:
             description: "Display Name"
             type: string
             format: string
          svc_grp_effective_state:
             description: "Service Group Effective State"
             type: string
             format: string
          partition_name:
             description: "Partition Name"
             type: string
             format: string
          comment:
             description: "Comment"
             type: string
             format: string
          svc_grp_mem_state:
             description: "Service Group Member State"
             type: string
             format: string
          svc_grp_mem_type:
             description: "Service Group Member Protocol Type"
             type: string
             format: string
      - $ref: '#/definitions/ns_servicegroup_readwrite'

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