Skip to content

management_ip

Overview

Get/Set management IP

Version information

Version : v2

URI scheme

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

Tags

  • management_ip : Operations related to management_ip

Paths

Get operation for management_ip

GET /management_ip

Description

Get Management IP Info.

Responses

HTTP Code Description Schema
200 API Successfully executed management_ip_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

  • management_ip

PUT operation for management_ip

PUT /management_ip

Description

Use this operation to change Management IP of SD-WAN Appliance

Parameters

Type Name Schema
Body body
optional
management_ip_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added management_ip_put_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

  • management_ip

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

gateway

Gateway IP of Management IP

Type : string

ip_address

Management IP Of System

Type : string

management_ip

Name Schema
gateway
optional
gateway
ip_address
optional
ip_address
netmask
optional
netmask

management_ip_delete_success_schema

Name Schema
management_ip
optional
management_ip

management_ip

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

management_ip_post_success_schema

Name Schema
management_ip
optional
management_ip

management_ip

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

management_ip_put_success_schema

Name Schema
management_ip
optional
management_ip

management_ip

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

management_ip_request_schema

Name Schema
management_ip
optional
management_ip

management_ip_response_schema

Type : < management_ip_response_schema > array

management_ip_response_schema

Name Schema
gateway
optional
gateway
ip_address
optional
ip_address
netmask
optional
netmask

netmask

Subnet mask of Management IP

Type : string