Skip to content

ha_service

Overview

API to add, delete, get, modify HA Service.

Version information

Version : v2

URI scheme

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

Tags

  • ha_service : Operations related to ha_service

Paths

POST operation for ha_service

POST /ha_service

Description

Use this operation to add HA Service

Parameters

Type Name Schema
Body body
optional
ha_service_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added ha_service_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

  • ha_service

Get operation for ha_service

GET /ha_service

Description

Use this operation to get HA Service

Responses

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

  • ha_service

PUT operation for ha_service

PUT /ha_service

Description

Use this operation to modify HA Service

Responses

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

Produces

  • application/json

Tags

  • ha_service

DELETE operation for ha_service

DELETE /ha_service/{deletePathParam}

Description

Use this operation to delete HA Service

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added ha_service_delete_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

Produces

  • application/json

Tags

  • ha_service

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

ha_interface_group

HA Interface group

Type : < ha_interface_group > array

ha_interface_group

Name Description Schema
external_tracker
optional
External Tracker IP Address < external_tracker > array
id
optional
Auto-generated ID to uniquely identify HA Interface Group integer
interface_properties
optional
HA Interface properties < interface_properties > array

external_tracker

Name Description Schema
id
optional
Auto-generated ID to uniquely identify HA External Tracker integer
ip_addr
optional
The IP Address of an external device that will respond to ARP requests to determine the state of the Primary Appliance string

interface_properties

Name Description Schema
id
optional
Auto-generated ID to uniquely identify HA Interface Properties integer
primary_ip_addr
optional
A unique Virtual IP Address on the Primary Appliance used for communication with its peer string
secondary_ip_addr
optional
A unique Virtual IP Address on the Secondary Appliance used for communication with its peer string
virtual_interface_name
optional
A Virtual Interface used for communication between the appliances in the HA pair string

ha_service

Name Schema
ha_interface_group
optional
ha_interface_group
ha_service_properties
optional
ha_service_properties
package_name
optional
package_name
site_name
optional
site_name

ha_service_delete_success_schema

Name Schema
ha_service
optional
ha_service

ha_service

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

ha_service_post_success_schema

Name Schema
ha_service
optional
ha_service

ha_service

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

ha_service_properties

HA Service properties

Type : < ha_service_properties > array

ha_service_properties

Name Description Schema
disable_shared_mac
optional
Disable Shared MAC Address of the two Appliances boolean
failover_ms
optional
The amount of time, upon losing contact with the active Appliance, that the standby Appliance should wait before going active (in milliseconds) integer
primary_appliance_name
optional
read-only
The primary appliance name string
primary_reclaim
optional
If enabled, the designated Primary Appliance will reclaim control from the active Appliance upon restarting after failover boolean
secondary_appliance_name
optional
read-only
The secondary appliance name string
shared_mac
optional
Shared MAC Address of the two Appliances string
swap_primary_secondary
optional
If enabled, the secondary Appliance will become the Primary Appliance and take precendence if both appliances come up simultaneously boolean
use_serial_ha
optional
Designates whether the two appliances are connected serially inline as a Fail-to-Wire pair boolean

ha_service_put_success_schema

Name Schema
ha_service
optional
ha_service

ha_service

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

ha_service_request_schema

Name Schema
ha_service
optional
ha_service

ha_service_response_schema

Type : < ha_service_response_schema > array

ha_service_response_schema

Name Schema
ha_interface_group
optional
ha_interface_group
ha_service_properties
optional
ha_service_properties
package_name
optional
package_name
site_name
optional
site_name

package_name

Config package name using which the site API operation should be performed.

Type : string

site_name

Site Name

Type : string