Skip to content

discovery_settings

Overview

This resource can be used to set and get the discovery settings.

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • discovery_settings : Operations related to discovery_settings

Paths

POST operation for discovery_settings

POST /discovery_settings

Description

Use this operation to set the Discovery settings.

Parameters

Type Name Description Schema
Query action
optional
Select if action is other that ADD enum (check_discovery_status, start_discovery, test, check_region_discovery_status, start_region_discovery)
Body body
optional
discovery_settings_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added discovery_settings_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • discovery_settings

Get operation for discovery_settings

GET /discovery_settings

Description

Use this operation to get the Discovery settings.

Responses

HTTP Code Description Schema
200 API Successfully executed discovery_settings_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • discovery_settings

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

bandwidth_limit

The maximum amount of bandwidth--in aggregate for all Sites--that can be used to transmit statistics from the Virtual WAN, in kbps (100-1000000). Defaults to 1000 kbps.

Type : integer

discovery_settings

Name Schema
bandwidth_limit
optional
bandwidth_limit
mcn_ip
optional
mcn_ip
poll_interval
optional
poll_interval

discovery_settings_delete_success_schema

Name Schema
discovery_settings
optional
discovery_settings

discovery_settings

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

discovery_settings_post_success_schema

Name Schema
discovery_settings
optional
discovery_settings

discovery_settings

Name Description Schema
message
optional
Example : "resource added succesfully" string

discovery_settings_put_success_schema

Name Schema
discovery_settings
optional
discovery_settings

discovery_settings

Name Description Schema
message
optional
Example : "resource modified succesfully" string

discovery_settings_request_schema

Name Schema
discovery_settings
optional
discovery_settings

discovery_settings_response_schema

Type : < discovery_settings_response_schema > array

discovery_settings_response_schema

Name Schema
bandwidth_limit
optional
bandwidth_limit
mcn_ip
optional
mcn_ip
poll_interval
optional
poll_interval

mcn_ip

The Master Controller Node IP Address

Type : string

poll_interval

The interval at which to collect statistics from Virtual WAN Appliances, in minutes (2-60). Defaults to 5 minutes.

Type : integer