swagger: '2.0'
info:
  description: Configuration for HA Proxy host details resource.
  version: 'v2'
  title: haproxyhost
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: haproxyhost
    description: HA Proxy host details
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 for all the managed devices
   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/haproxyhost:
    get:
      tags:
        - haproxyhost
      summary: GET all haproxyhost
      operationId: getall_haproxyhost
      description: Use this operation to get a HAProxy host
      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 haproxyhost 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 haproxyhost 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 haproxyhost resources.
          enum:
            - yes
      responses:
        200:
          description:  for haproxyhost
          schema: 
              $ref: '#/definitions/gethaproxyhostsResponse'
        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:
        - haproxyhost
      summary: POST operation for haproxyhost
      operationId: post_haproxyhost
      description: POST operation for haproxyhost
      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: haproxyhost
          description: haproxyhost object
          schema:
              $ref: '#/definitions/addhaproxyhostRequest'
      responses:
        200:
          description: add for haproxyhost
          schema: 
              $ref: '#/definitions/addhaproxyhostResponse'
        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/haproxyhost/{id}:
    get:
      tags:
        - haproxyhost
      summary: GET by key for haproxyhost
      operationId: getbykey_haproxyhost
      description: Use this operation to get a HAProxy host
      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 haproxyhost
          schema: 
              $ref: '#/definitions/gethaproxyhostResponse'
        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:
        - haproxyhost
      summary: Delete for haproxyhost
      operationId: deletebykey_haproxyhost
      description: Use this operation to delete a HAProxy host
      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 haproxyhost
        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:
  addhaproxyhostRequest:
    type: object
    required:
      - haproxyhost
    properties:
      haproxyhost:
        $ref: '#/definitions/haproxyhost_readwrite'
    title: addhaproxyhostRequest
    example:
      haproxyhost:
        instance_classifier: "0"
        hostname: "string_value"
        gateway_deployment: "false"
        std_bw_config: "0"
        gateway_ipv6: "string_value"
        instance_available: "0"
        device_finger_print: "string_value"
        name: "string_value"
        description: "Provisioned on 10 Jan 18"
        ent_bw_available: "0"
        is_autoscale_group: "false"
        geo_support: "false"
        sslvpn_config: "0"
        mastools_version: "string_value"
        sysservices: "number_value"
        ent_bw_total: "0"
        vcpu_config: "0"
        netmask: "255.255.255.0"
        ent_bw_config: "0"
        autoprovisioned: "false"
        datacenter_id: "string_value"
        instance_config: "0"
        is_managed: "true"
        instance_mode: "string_value"
        discovery_time: "number_value"
        instance_total: "0"
        is_ha_configured: "false"
        trust_id: "string_value"
        ipv4_address: "string_value"
        profile_name: "string_value"
        std_bw_available: "0"
        servicepackage: "string_value"
        last_updated_time: "number_value"
        plt_bw_total: "0"
        ipv6_address: "string_value"
        mgmt_ip_address: "string_value"
        license_edition: "string_value"
        partition_id: "string_value"
        plt_bw_available: "0"
        device_family: "string_value"
        template_interval: "60"
        type: "string_value"
        gateway: "string_value"
        internal_annotation: "NA"
        config_type: "0"
        node_id: "string_value"
        isolation_policy: "string_value"
        ip_address: "string_value"
        provision_request_id: "48f867d1-3d10-4bfa-8498-604a57e67bc5"
        httpxforwardedfor: "string_value"
        display_name: "string_value"
        std_bw_total: "0"
        partition_name: "string_value"
        plt_bw_config: "0"
        sslvpn_total: "0"
        agent_id: "string_value"
        peer_device_ip: "10.102.40.26"
        profile_password: "string_value"
        file_name: "string_value"
        profile_username: "string_value"
        file_location_path: "string_value"
        peer_host_device_ip: "string_value"
        device_host_ip: "10.102.40.25"
        tr_task_id: "string_value"
        entity_tag: [{        prop_value: "string_value"
,        prop_key: "string_value"
}]

  addhaproxyhostResponse:
    type: object
    required:
      - haproxyhost
    properties:
      haproxyhost:
        $ref: '#/definitions/haproxyhost'
    title: addhaproxyhostResponse
    example:
      haproxyhost:
        instance_classifier: "0"
        subnet_id: "string_value"
        is_grace: "false"
        manufacturedate: "string_value"
        hostname: "string_value"
        gateway_deployment: "false"
        std_bw_config: "0"
        is_fips_pooled_license_type: "0"
        acu_total: "0"
        ha_master_state: "string_value"
        gateway_ipv6: "string_value"
        instance_available: "0"
        vpc_id: "string_value"
        instance_state: "Down"
        device_finger_print: "string_value"
        enabled: "true"
        name: "string_value"
        reason: "string_value"
        region: "string_value"
        disk_space: "number_value"
        description: "Provisioned on 10 Jan 18"
        ent_bw_available: "0"
        is_autoscale_group: "false"
        disk_free: "number_value"
        geo_support: "false"
        is_pooled_license: "false"
        sslvpn_config: "0"
        upsince: "string_value"
        user_driven: "true"
        private_dns: "string_value"
        security_group: "string_value"
        model_id: "string_value"
        mastools_version: "string_value"
        zone: "string_value"
        disk_usage: "number_value"
        sysservices: "number_value"
        ent_bw_total: "0"
        tenant_id: "string_value"
        vcpu_config: "0"
        netmask: "255.255.255.0"
        device_uuid: "string_value"
        ent_bw_config: "0"
        autoprovisioned: "false"
        do_config: "true"
        tx: "0"
        version: "string_value"
        host_id: "string_value"
        datacenter_id: "string_value"
        instance_config: "0"
        is_managed: "true"
        instance_mode: "string_value"
        discovery_time: "number_value"
        number_of_cpu: "56"
        instance_total: "0"
        public_dns: "string_value"
        is_ha_configured: "false"
        memory_free: "232306"
        trust_id: "string_value"
        ipv4_address: "string_value"
        instance_type: "string_value"
        profile_name: "string_value"
        std_bw_available: "0"
        seq_no: "number_value"
        sysid: "string_value"
        servicepackage: "string_value"
        uuid: "eefa3cbc-9585-4955-b4f5-80901cdf595b"
        scu_total: "0"
        last_updated_time: "number_value"
        cloud: "string_value"
        encoded_serialnumber: "string_value"
        instance_unique_id: "0"
        uptime: "string_value"
        plt_bw_total: "0"
        private_ip: "string_value"
        id: "string_value"
        ipv6_address: "string_value"
        mgmt_ip_address: "string_value"
        license_edition: "string_value"
        partition_id: "string_value"
        plt_bw_available: "0"
        cpufrequncy: "integer_value"
        cpu_license_type: "0"
        location: "string_value"
        device_family: "string_value"
        template_interval: "60"
        ha_sync: "string_value"
        contactperson: "string_value"
        public_ip: "string_value"
        ha_ip_address: "string_value"
        scu_free: "0"
        total_crypto_devices: "0"
        acu_free: "0"
        cpu_usage: "7.40"
        type: "string_value"
        bmcrevision: "-NA-"
        memory_total: "11.34"
        status: "string_value"
        gateway: "string_value"
        internal_annotation: "NA"
        config_type: "0"
        systemname: "string_value"
        node_id: "string_value"
        geo_location: "string_value"
        isolation_policy: "string_value"
        ip_address: "string_value"
        ping_state: "integer_value"
        provision_request_id: "48f867d1-3d10-4bfa-8498-604a57e67bc5"
        httpxforwardedfor: "string_value"
        rx: "0"
        ssl_cores_total: "0"
        memory_usage: "11.34"
        display_name: "string_value"
        std_bw_total: "0"
        ami_id: "string_value"
        number_of_cpu_cores: "0"
        partition_name: "string_value"
        plt_bw_config: "0"
        sslvpn_total: "0"
        agent_id: "string_value"
        serialnumber: "string_value"
        peer_device_ip: "10.102.40.26"
        parent_inventory: "boolean_value"
        profile_password: "string_value"
        register_failed_device: "false"
        ssl_cores_free: "0"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        file_name: "string_value"
        do_instance_config: "true"
        profile_username: "string_value"
        default_password: "string_value"
        file_location_path: "string_value"
        sync_operation: "true"
        peer_host_device_ip: "string_value"
        device_host_ip: "10.102.40.25"
        tr_task_id: "string_value"
        entity_tag: [{        prop_value: "string_value"
,        prop_key: "string_value"
}]
        force_password_change: "false"

  gethaproxyhostResponse:
    type: object
    required:
      - haproxyhost
    properties:
      haproxyhost:
        $ref: '#/definitions/haproxyhost'
    title: gethaproxyhostResponse
    example:
      haproxyhost:
        instance_classifier: "0"
        subnet_id: "string_value"
        is_grace: "false"
        manufacturedate: "string_value"
        hostname: "string_value"
        gateway_deployment: "false"
        std_bw_config: "0"
        is_fips_pooled_license_type: "0"
        acu_total: "0"
        ha_master_state: "string_value"
        gateway_ipv6: "string_value"
        instance_available: "0"
        vpc_id: "string_value"
        instance_state: "Down"
        device_finger_print: "string_value"
        enabled: "true"
        name: "string_value"
        reason: "string_value"
        region: "string_value"
        disk_space: "number_value"
        description: "Provisioned on 10 Jan 18"
        ent_bw_available: "0"
        is_autoscale_group: "false"
        disk_free: "number_value"
        geo_support: "false"
        is_pooled_license: "false"
        sslvpn_config: "0"
        upsince: "string_value"
        user_driven: "true"
        private_dns: "string_value"
        security_group: "string_value"
        model_id: "string_value"
        mastools_version: "string_value"
        zone: "string_value"
        disk_usage: "number_value"
        sysservices: "number_value"
        ent_bw_total: "0"
        tenant_id: "string_value"
        vcpu_config: "0"
        netmask: "255.255.255.0"
        device_uuid: "string_value"
        ent_bw_config: "0"
        autoprovisioned: "false"
        do_config: "true"
        tx: "0"
        version: "string_value"
        host_id: "string_value"
        datacenter_id: "string_value"
        instance_config: "0"
        is_managed: "true"
        instance_mode: "string_value"
        discovery_time: "number_value"
        number_of_cpu: "56"
        instance_total: "0"
        public_dns: "string_value"
        is_ha_configured: "false"
        memory_free: "232306"
        trust_id: "string_value"
        ipv4_address: "string_value"
        instance_type: "string_value"
        profile_name: "string_value"
        std_bw_available: "0"
        seq_no: "number_value"
        sysid: "string_value"
        servicepackage: "string_value"
        uuid: "eefa3cbc-9585-4955-b4f5-80901cdf595b"
        scu_total: "0"
        last_updated_time: "number_value"
        cloud: "string_value"
        encoded_serialnumber: "string_value"
        instance_unique_id: "0"
        uptime: "string_value"
        plt_bw_total: "0"
        private_ip: "string_value"
        id: "string_value"
        ipv6_address: "string_value"
        mgmt_ip_address: "string_value"
        license_edition: "string_value"
        partition_id: "string_value"
        plt_bw_available: "0"
        cpufrequncy: "integer_value"
        cpu_license_type: "0"
        location: "string_value"
        device_family: "string_value"
        template_interval: "60"
        ha_sync: "string_value"
        contactperson: "string_value"
        public_ip: "string_value"
        ha_ip_address: "string_value"
        scu_free: "0"
        total_crypto_devices: "0"
        acu_free: "0"
        cpu_usage: "7.40"
        type: "string_value"
        bmcrevision: "-NA-"
        memory_total: "11.34"
        status: "string_value"
        gateway: "string_value"
        internal_annotation: "NA"
        config_type: "0"
        systemname: "string_value"
        node_id: "string_value"
        geo_location: "string_value"
        isolation_policy: "string_value"
        ip_address: "string_value"
        ping_state: "integer_value"
        provision_request_id: "48f867d1-3d10-4bfa-8498-604a57e67bc5"
        httpxforwardedfor: "string_value"
        rx: "0"
        ssl_cores_total: "0"
        memory_usage: "11.34"
        display_name: "string_value"
        std_bw_total: "0"
        ami_id: "string_value"
        number_of_cpu_cores: "0"
        partition_name: "string_value"
        plt_bw_config: "0"
        sslvpn_total: "0"
        agent_id: "string_value"
        serialnumber: "string_value"
        peer_device_ip: "10.102.40.26"
        parent_inventory: "boolean_value"
        profile_password: "string_value"
        register_failed_device: "false"
        ssl_cores_free: "0"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        file_name: "string_value"
        do_instance_config: "true"
        profile_username: "string_value"
        default_password: "string_value"
        file_location_path: "string_value"
        sync_operation: "true"
        peer_host_device_ip: "string_value"
        device_host_ip: "10.102.40.25"
        tr_task_id: "string_value"
        entity_tag: [{        prop_value: "string_value"
,        prop_key: "string_value"
}]
        force_password_change: "false"

  gethaproxyhostsResponse:
    type: object
    required:
      - haproxyhost
    properties:
      haproxyhost:
        type: array
        items:
          $ref: '#/definitions/haproxyhost'
    title: gethaproxyhostsResponse
    example:
      haproxyhost:
        instance_classifier: "0"
        subnet_id: "string_value"
        is_grace: "false"
        manufacturedate: "string_value"
        hostname: "string_value"
        gateway_deployment: "false"
        std_bw_config: "0"
        is_fips_pooled_license_type: "0"
        acu_total: "0"
        ha_master_state: "string_value"
        gateway_ipv6: "string_value"
        instance_available: "0"
        vpc_id: "string_value"
        instance_state: "Down"
        device_finger_print: "string_value"
        enabled: "true"
        name: "string_value"
        reason: "string_value"
        region: "string_value"
        disk_space: "number_value"
        description: "Provisioned on 10 Jan 18"
        ent_bw_available: "0"
        is_autoscale_group: "false"
        disk_free: "number_value"
        geo_support: "false"
        is_pooled_license: "false"
        sslvpn_config: "0"
        upsince: "string_value"
        user_driven: "true"
        private_dns: "string_value"
        security_group: "string_value"
        model_id: "string_value"
        mastools_version: "string_value"
        zone: "string_value"
        disk_usage: "number_value"
        sysservices: "number_value"
        ent_bw_total: "0"
        tenant_id: "string_value"
        vcpu_config: "0"
        netmask: "255.255.255.0"
        device_uuid: "string_value"
        ent_bw_config: "0"
        autoprovisioned: "false"
        do_config: "true"
        tx: "0"
        version: "string_value"
        host_id: "string_value"
        datacenter_id: "string_value"
        instance_config: "0"
        is_managed: "true"
        instance_mode: "string_value"
        discovery_time: "number_value"
        number_of_cpu: "56"
        instance_total: "0"
        public_dns: "string_value"
        is_ha_configured: "false"
        memory_free: "232306"
        trust_id: "string_value"
        ipv4_address: "string_value"
        instance_type: "string_value"
        profile_name: "string_value"
        std_bw_available: "0"
        seq_no: "number_value"
        sysid: "string_value"
        servicepackage: "string_value"
        uuid: "eefa3cbc-9585-4955-b4f5-80901cdf595b"
        scu_total: "0"
        last_updated_time: "number_value"
        cloud: "string_value"
        encoded_serialnumber: "string_value"
        instance_unique_id: "0"
        uptime: "string_value"
        plt_bw_total: "0"
        private_ip: "string_value"
        id: "string_value"
        ipv6_address: "string_value"
        mgmt_ip_address: "string_value"
        license_edition: "string_value"
        partition_id: "string_value"
        plt_bw_available: "0"
        cpufrequncy: "integer_value"
        cpu_license_type: "0"
        location: "string_value"
        device_family: "string_value"
        template_interval: "60"
        ha_sync: "string_value"
        contactperson: "string_value"
        public_ip: "string_value"
        ha_ip_address: "string_value"
        scu_free: "0"
        total_crypto_devices: "0"
        acu_free: "0"
        cpu_usage: "7.40"
        type: "string_value"
        bmcrevision: "-NA-"
        memory_total: "11.34"
        status: "string_value"
        gateway: "string_value"
        internal_annotation: "NA"
        config_type: "0"
        systemname: "string_value"
        node_id: "string_value"
        geo_location: "string_value"
        isolation_policy: "string_value"
        ip_address: "string_value"
        ping_state: "integer_value"
        provision_request_id: "48f867d1-3d10-4bfa-8498-604a57e67bc5"
        httpxforwardedfor: "string_value"
        rx: "0"
        ssl_cores_total: "0"
        memory_usage: "11.34"
        display_name: "string_value"
        std_bw_total: "0"
        ami_id: "string_value"
        number_of_cpu_cores: "0"
        partition_name: "string_value"
        plt_bw_config: "0"
        sslvpn_total: "0"
        agent_id: "string_value"
        serialnumber: "string_value"
        peer_device_ip: "10.102.40.26"
        parent_inventory: "boolean_value"
        profile_password: "string_value"
        register_failed_device: "false"
        ssl_cores_free: "0"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        file_name: "string_value"
        do_instance_config: "true"
        profile_username: "string_value"
        default_password: "string_value"
        file_location_path: "string_value"
        sync_operation: "true"
        peer_host_device_ip: "string_value"
        device_host_ip: "10.102.40.25"
        tr_task_id: "string_value"
        entity_tag: [{        prop_value: "string_value"
,        prop_key: "string_value"
}]
        force_password_change: "false"

  haproxyhost_readwrite:
    type: object
    properties:
      instance_classifier:
        description: "Value based on which certain features may be enabled/disabled in ADM for the instance"
        type: integer
        format: int32
      hostname:
        description: "Assign hostname to managed device, if this is not provided, name will be set as host name "
        type: string
        format: string
        minLength: 1
        maxLength: 256
      gateway_deployment:
        description: "Is this device acting as Gateway."
        type: boolean
        format: boolean
      std_bw_config:
        description: "Standard Bandwidth running"
        type: integer
        format: int32
      gateway_ipv6:
        description: "Gateway IPv6 Address"
        type: string
        format: string
      instance_available:
        description: "Instance license available"
        type: integer
        format: int32
      device_finger_print:
        description: "Fingerprint/thumb-print from UMS public certificate for SSL communication"
        type: string
        format: string
      name:
        description: "Name of managed device"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      description:
        description: "Description of managed device"
        type: string
        format: string
        minLength: 1
        maxLength: 512
      ent_bw_available:
        description: "Enterprise Bandwidth configured"
        type: integer
        format: int32
      is_autoscale_group:
        description: "Does this device belong to an Autoscale Group."
        type: boolean
        format: boolean
      geo_support:
        description: "Is this device configured to support GEO location."
        type: boolean
        format: boolean
      sslvpn_config:
        description: "sslvpn license maximum"
        type: integer
        format: int32
      mastools_version:
        description: "Mastools version if the device is embedded agent"
        type: string
        format: string
      sysservices:
        description: "System Services"
        type: number
        format: int64
      ent_bw_total:
        description: "Enterprise Bandwidth Total"
        type: integer
        format: int32
      vcpu_config:
        description: "Number of vCPU allocated for the device"
        type: integer
        format: int32
      netmask:
        description: "Netmask of managed device"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      ent_bw_config:
        description: "Enterprise Bandwidth configured"
        type: integer
        format: int32
      autoprovisioned:
        description: "Device is auto-provisioned or not"
        type: boolean
        format: boolean
      datacenter_id:
        description: "Datacenter Id is system generated key for data center"
        type: string
        format: string
      instance_config:
        description: "Instance license running"
        type: integer
        format: int32
      is_managed:
        description: "Is Managed"
        type: boolean
        format: boolean
      instance_mode:
        description: "Denotes state- primary,secondary,clip,clusternode"
        type: string
        format: string
      discovery_time:
        description: "discovery time"
        type: number
        format: int64
      instance_total:
        description: "Instance license"
        type: integer
        format: int32
      is_ha_configured:
        description: "Is HA configured"
        type: boolean
        format: boolean
      trust_id:
        description: "Device ID obtained from trust service"
        type: string
        format: string
      ipv4_address:
        description: "IPv4 Address"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      profile_name:
        description: "Device Profile Name that is attached with this managed device"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      std_bw_available:
        description: "Standard Bandwidth Available"
        type: integer
        format: int32
      servicepackage:
        description: "Service Package Name of the device"
        type: string
        format: string
      last_updated_time:
        description: "Last Updated Time"
        type: number
        format: int64
      plt_bw_total:
        description: "Total Platinum Bandwidth"
        type: integer
        format: int32
      ipv6_address:
        description: "IPv6 Address"
        type: string
        format: string
      mgmt_ip_address:
        description: "Management IP Address for this Managed Device"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      license_edition:
        description: "Edition of instance"
        type: string
        format: string
      partition_id:
        description: "ID of admin partition"
        type: string
        format: string
      plt_bw_available:
        description: "Platinum Bandwidth Available"
        type: integer
        format: int32
      device_family:
        description: "Device Family"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      template_interval:
        description: "Template refresh interval"
        type: integer
        format: int32
      type:
        description: "Type of device, (Xen | NS)"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      gateway:
        description: "Default Gateway of managed device"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      internal_annotation:
        description: "Internal annotation used by ADM.Example, if a device is marked for delete"
        type: string
        format: string
      config_type:
        description: "Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both"
        type: integer
        format: int32
      node_id:
        description: "Node identification of a device"
        type: string
        format: string
      isolation_policy:
        description: "Isolation Policy of the Device"
        type: string
        format: string
      ip_address:
        description: "IP Address for this managed device"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      provision_request_id:
        description: "Value is set only if the instance was provisioned from Citrix ADM"
        type: string
        format: uuid
      httpxforwardedfor:
        description: "HTTP x-Forwardedfor header flag."
        type: string
        format: string
        minLength: 1
        maxLength: 10
      display_name:
        description: "Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      std_bw_total:
        description: "Standard Bandwidth"
        type: integer
        format: int32
      partition_name:
        description: "Citrix ADC Admin Partition Name"
        type: string
        format: string
        maxLength: 512
      plt_bw_config:
        description: "Platinum Bandwidth configured"
        type: integer
        format: int32
      sslvpn_total:
        description: "sslvpn license"
        type: integer
        format: int32
      agent_id:
        description: "Agent Id"
        type: string
        format: string
      peer_device_ip:
        description: "Peer Device IP address for instance of type BLX ADC."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      profile_password:
        description: "Password specified by the user for this Citrix ADC Instance."
        type: string
        format: password
        minLength: 1
        maxLength: 128
      file_name:
        description: "File name which contains comma separated instances to be  discovered"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      profile_username:
        description: "User Name specified by the user for this Citrix ADC Instance."
        type: string
        format: string
        minLength: 1
        maxLength: 128
      file_location_path:
        description: "File Location on Client for upload/download"
        type: string
        format: string
        minLength: 1
      peer_host_device_ip:
        description: "Peer Host Device IP Address for instance of type BLX ADC."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      device_host_ip:
        description: "Device Host IP Address for instance of type BLX ADC."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      tr_task_id:
        description: "Task Id used by Triton to identify NS"
        type: string
        format: string
      entity_tag:
        type: array
        items:
          $ref: '#/definitions/property_map_readwrite'

  haproxyhost:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the managed devices
            type: string
            format: string
          subnet_id:
             description: "in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS)"
             type: string
             format: string
          manufacturedate:
             description: "Manufacture Date"
             type: string
             format: string
          is_fips_pooled_license_type:
             description: "FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license"
             type: integer
             format: int32
          acu_total:
             description: "Total Asymmetric Crypto Units available in host"
             type: integer
             format: int32
          ha_master_state:
             description: "Master State (Primary/Secondary)"
             type: string
             format: string
             minLength: 1
             maxLength: 32
          vpc_id:
             description: "VPC ID of the managed device"
             type: string
             format: string
          instance_state:
             description: "State of device, UP only if device accessible"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          enabled:
             description: "host State"
             type: boolean
             format: boolean
          reason:
             description: "Reason of failure for this managed device"
             type: string
             format: string
             minLength: 1
             maxLength: 1024
          region:
             description: "Region in which the managed device is hosted"
             type: string
             format: string
          disk_space:
             description: "Show Disk Space (MB) available on host"
             type: number
             format: double
          disk_free:
             description: "Show free Disk Space (MB) available on host"
             type: number
             format: double
          upsince:
             description: "Upsince of managed device"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          private_dns:
             description: "Private DNS of the managed device"
             type: string
             format: string
          security_group:
             description: "virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS)"
             type: string
             format: string
          model_id:
             description: "Device Model Id"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          zone:
             description: "Zone in which the managed device is hosted"
             type: string
             format: string
          disk_usage:
             description: "Disk usage (MB) for host"
             type: number
             format: double
          tenant_id:
             description: "Tenant ID"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          device_uuid:
             description: "Device UUID"
             type: string
             format: string
          do_config:
             description: "Do default config for managed device"
             type: boolean
             format: boolean
          tx:
             description: "Out Throughput (Mbps) of host"
             type: number
             format: double
          version:
             description: "Device Version"
             type: string
             format: string
             minLength: 1
             maxLength: 256
          host_id:
             description: "Host ID"
             type: string
             format: string
          number_of_cpu:
             description: "Number of total CPU of host"
             type: integer
             format: int32
          public_dns:
             description: "Public DNS of the managed device"
             type: string
             format: string
          memory_free:
             description: "Free memory available (MB) in host"
             type: number
             format: double
          instance_type:
             description: "Instance type indicates the deployment type of CPX"
             type: string
             format: string
          sysid:
             description: "System ID"
             type: string
             format: string
          uuid:
             description: "UUID of host"
             type: string
             format: uuid
             minLength: 1
             maxLength: 128
          scu_total:
             description: "Total Symmetric Crypto Units available in host"
             type: integer
             format: int32
          cloud:
             description: "Cloud on which the managed device is hosted"
             type: string
             format: string
          encoded_serialnumber:
             description: "Encoded Serial Number"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          instance_unique_id:
             description: "32 bit unique Integer id generated by Citrix ADM for this device"
             type: integer
             format: int32
          uptime:
             description: "Uptime of device"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          private_ip:
             description: "Private IP of the managed device"
             type: string
             format: string
          cpufrequncy:
             description: "CPU Frequency (MHZ)"
             type: integer
             format: int32
          cpu_license_type:
             description: "VCPU license 0 = No VCPU License, 1 = VCPU Pool license"
             type: integer
             format: int32
          location:
             description: "Device Location"
             type: string
             format: string
             minLength: 1
             maxLength: 127
          ha_sync:
             description: "HA Synchronization State"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          contactperson:
             description: "Device contact person"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          public_ip:
             description: "Public IP of the managed device"
             type: string
             format: string
          ha_ip_address:
             description: "Peer IP Address"
             type: string
             format: IP Address
             minLength: 1
             maxLength: 64
          scu_free:
             description: "Free Symmetric Crypto Units"
             type: integer
             format: int32
          total_crypto_devices:
             description: "Total Crypto Devices"
             type: integer
             format: int32
          cpu_usage:
             description: "CPU Usage (%) of host"
             type: number
             format: double
          acu_free:
             description: "Free Asymmetric Crypto Units"
             type: integer
             format: int32
          bmcrevision:
             description: "BMC Firmware Version"
             type: string
             format: string
          memory_total:
             description: "Total memory of host in MB"
             type: number
             format: double
          status:
             description: "Status of managed device"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          systemname:
             description: "Device System Name"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          geo_location:
             description: "Geo location of the managed device"
             type: string
             format: string
          ssl_cores_total:
             description: "Total SSL Cores available in host"
             type: integer
             format: int32
          rx:
             description: "In Throughput (Mbps) of host"
             type: number
             format: double
          memory_usage:
             description: "Memory Usage (%) of host"
             type: number
             format: double
          ami_id:
             description: "AMI ID of the managed device (if hosted on AWS)"
             type: string
             format: string
          number_of_cpu_cores:
             description: "Number of total CPU cores of host"
             type: integer
             format: int32
          serialnumber:
             description: "Device Serial Number"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          ssl_cores_free:
             description: "Free SSL Cores"
             type: integer
             format: int32
          act_id:
             description: "Activity Id"
             type: string
             format: uuid
      - $ref: '#/definitions/haproxyhost_readwrite'

  property_map_readwrite:
    type: object
    properties:
      prop_value:
        description: "Property value"
        type: string
        format: string
        minLength: 1
        maxLength: 512
      prop_key:
        description: "Property key"
        type: string
        format: string
        minLength: 1
        maxLength: 128

  property_map:
    allOf:
      - $ref: '#/definitions/property_map_readwrite'

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