Device42 Snmp API

openapi: 3.2.0
info:
  title: Device42 Snmp API
  version: '2.0'
  description: 'API Overview


    RESTful APIs are supported in Device42 as one of the primary methods of entering, editing and retrieving data.'
  contact:
    name: Device42
    email: support@device42.com
servers:
- url: https://<host>
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: SNMP
paths:
  /api/1.0/auto_discovery/networks/:
    post:
      operationId: postAuto_discoveryNetworks
      description: Create/update network discovery job
      summary: Create/update network job
      tags:
      - SNMP
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  description: name of the job
                  type: string
                server:
                  description: FQDN or IP of the server(s) or cidr or ranges.
                  type: string
                exclude_servers:
                  description: IP or FQDN of server(s) or cidr or ranges to exclude.
                  type: string
                service_level:
                  description: Must already exist
                  type: string
                clear_service_level:
                  description: Clear existing service level.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                customer:
                  description: Name of customer/department.
                  type: string
                clear_customer:
                  description: Clear existing customer.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                ip_address:
                  description: IP address.<br><b>NOTE</b> - this is a legacy parameter; use server param instead.
                  type: string
                end_ip_address:
                  description: End IP address.<br><b>NOTE</b> - this is a legacy parameter; use server param instead.
                  type: string
                enable_pdu_monitoring:
                  description: Enable PDU monitoring - yes/no.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                polling_interval:
                  description: Polling interval in seconds. Adjusted to the nearest available interval value. (e.g., 300 = 5 minutes, 1800 = 30 minutes).
                  type: integer
                remote_collector_id:
                  description: <b>Note:</b> REQUIRED if you enable PDU Monitoring.<br>The D42 ID of the remote collector to use for this job.
                  type: string
                do_port_check:
                  description: Run nmap port-scan prior to discovery.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                snmp_min_parallel:
                  description: Set nmap option min_parallelism (Only change if directed by Support).
                  type: integer
                snmp_string:
                  description: required, if new
                  type: string
                snmp_strings:
                  description: Can be comma separated list of community strings to use multiple community strings
                  type: string
                snmp_string_ids:
                  description: Can be comma separated list of community string IDs to use multiple community strings
                  type: string
                schedule_time:
                  description: 'Time in HH:MM format if you want to schedule the job. Note: Must be formatted as text NOT date. For multiple schedules, separate with a slash (/).'
                  type: string
                schedule_days:
                  description: Comma separated days of week, where Monday = 0. e.g. 0,1,2 will set the job for Mon, Tue and Wed. For multiple schedules, separate with a slash (/).
                  type: string
                strip_domain_name:
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                autodiscover_cdp_devices:
                  description: yes to enable CDP/LLDP (added in v8.3.2)
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                use_name_alias_port_descr:
                  description: yes to use alias for port description during discovery (added in v8.3.2)
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                clear_existing_schedule:
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                groups:
                  description: name of one or more groups separated by commas
                  type: string
                mask_bits:
                  description: mask bits (integer only)
                  type: integer
                snmp_port:
                  description: snmp port (integer only) (added in v10.4.0)
                  type: integer
                snmp_version:
                  type: string
                  enum:
                  - v1
                  - v2c
                  - v3
                  default: v2c
                snmp_string_id:
                  description: The id of the password for the community string
                  type: string
                snmpv3_auth_password_id:
                  description: The id of the password for the auth password
                  type: string
                snmpv3_privacy_protocol_password_id:
                  description: The id of the password for the privacy protocol password
                  type: string
                snmpv3_user:
                  description: name of snmp v3 user (added in v10.4.0)
                  type: string
                snmpv3_auth_mode:
                  type: string
                  enum:
                  - noAuthoNoPriv
                  - authNoPriv
                  - authPriv
                snmpv3_auth_protocol:
                  type: string
                  enum:
                  - MD5
                  - SHA
                  - SHA256
                  - SHA512
                snmpv3_auth_password:
                  description: password (added in v10.4.0)
                  type: string
                snmpv3_privacy_protocol:
                  type: string
                  enum:
                  - DES
                  - 3DES
                  - AES
                  - AES128
                  - AES192
                  - AES192C
                  - AES256
                  - AES256C
                snmpv3_privacy_protocol_password:
                  description: password (added in v10.4.0)
                  type: string
                snmpv3_context:
                  type: string
                get_all_switch_ports:
                  description: yes or no to get all switch ports (added in v10.4.0)
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                delete_older_mac_association_after:
                  description: number of days (added in v10.4.0)
                  type: string
                delete_switch_port_not_found:
                  description: yes or no to delete switch ports not found (added in v10.4.0)
                  type: string
                vlans_to_ignore:
                  description: list of vlan ids to ignore separated by commas (added in v10.4.0). Use the value 'D42_NULL' to clear up the content of the vlans_to_ignore field.
                  type: string
                port_name_prefix_to_ignore_macs:
                  type: string
                debug_level:
                  type: string
                  enum:
                  - No Debug
                  - Normal Debug
                  - Extended Debug
                hostname_precedence:
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                skip_vlan_indexing:
                  description: yes or no (added in v10.4.0)
                  type: string
                vrfgroup:
                  description: name of vrf group for discovered subnets (added in v10.4.0)
                  type: string
                object_category:
                  description: name of subnet category for discovered subnets
                  type: string
                discover_services:
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                discover_parts:
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                tags:
                  description: add tags (comma separated)
                  type: string
                tags_remove:
                  description: remove tags (comma separated)
                  type: string
                remove_password_ids:
                  description: Comma separated list of D42 IDs of existing secret records to be removed from the job.
                  type: string
              required:
              - name
        required: true
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example: network autodiscovery job added
                  code:
                    example: 0
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  responses:
    Forbidden:
      description: Forbidden (The resource requested is hidden)
      content:
        application/json:
          example:
            errors:
            - code: 403
              reason: Forbidden
              title: Forbidden
              detail: The resource requested is hidden
    BadRequest:
      description: Bad Request (A validation exception has occurred.)
      content:
        application/json:
          example:
            errors:
            - code: 400
              reason: BAD_REQUEST
              title: The error response code title.
              detail: Details of the error response.
    Unauthorized:
      description: Unauthorized (Invalid credentials.)
      content:
        application/json:
          example:
            errors:
            - code: 401
              reason: Unauthorized
              title: Unauthorized
              detail: Invalid credentials.
    InternalServerError:
      description: Internal Server Error (A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.)
      content:
        application/json:
          example:
            errors:
            - code: 500
              reason: Internal Server Error
              title: Internal Server Error
              detail: A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.
    NotFound:
      description: Not Found (The specified resource could not be found)
      content:
        application/json:
          example:
            errors:
            - code: 404
              reason: Not Found
              title: Not Found
              detail: The specified resource could not be found.
    ServiceUnavailable:
      description: Service Unavailable (Please check if your Device42 instance is working normally.)
      content:
        application/json:
          example:
            errors:
            - code: 503
              reason: Service Unavailable
              title: Service Unavailable
              detail: Please check if your Device42 instance is working normally.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication using a Device42 user's username and password.
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /tauth/1.0/token/ using an API Client's key/secret as Basic auth credentials.