virtual_ip_addresses

Configuration Editor for API to add, modify, delete, and get Virtual IP Address resource.

Read/write properties

is_private <Boolean>

If enabled, the Virtual IP Address will only be routable on the local Appliance.

is_identity <Boolean>

If enabled, the Virtual IP Address will be used for IP services.

package_name <String>

Config package name using which the virtual_ip_addresses API operation should be performed.. Minimum length = 1 Maximum length = 141

is_auto <Boolean>

.

virtual_interface_name <String>

Enter one of the associated Virtual Interfaces. Minimum length = 1 Maximum length = 42

ip_address <String>

IP Address with prefix.

id <Integer>

Auto-generated ID. Use this ID to modify or delete a Virtual IP address.

site_name <String>

Site Name. Minimum length = 1 Maximum length = 42

Read only properties

Operations

add delete get (all) modify

[add]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtual_ip_addresses

Description: Use this operation to add a Virtual IP address

HTTP Method: POST

Request Payload: JSON

{"virtual_ip_addresses": { "is_private":<Boolean_value> , "is_identity":<Boolean_value> , "package_name":<String_value> , "is_auto":<Boolean_value> , "virtual_interface_name":<String_value> , "ip_address":<String_value> , "id":<Integer_value> , "site_name":<String_value> }}

Response Payload: JSON

{ "virtual_ip_addresses":{ "is_private":<Boolean_value>

, "is_identity":<Boolean_value> , "package_name":<String_value> , "is_auto":<Boolean_value> , "virtual_interface_name":<String_value> , "ip_address":<String_value> , "id":<Integer_value> , "site_name":<String_value> }]}

[delete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtual_ip_addresses/package_name=<String>

Description: Use this operation to delete a Virtual IP address

HTTP Method: DELETE

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value> }

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtual_ip_addresses/package_name=<package_name>

Description: Use this operation to get the list of Virtual IP addresses

HTTP Method: GET

Response Payload: JSON

{"virtual_ip_addresses":[{ "is_private":<Boolean_value>

, "is_identity":<Boolean_value> , "package_name":<String_value> , "is_auto":<Boolean_value> , "virtual_interface_name":<String_value> , "ip_address":<String_value> , "id":<Integer_value> , "site_name":<String_value> }]}

[modify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtual_ip_addresses

Description: Use this operation to modify a Virtual IP address

HTTP Method: PUT

Request Payload: JSON

{"virtual_ip_addresses":{ "is_private":<Boolean_value> , "is_identity":<Boolean_value> , "package_name":<String_value> , "is_auto":<Boolean_value> , "virtual_interface_name":<String_value> , "ip_address":<String_value> , "id":<Integer_value> , "site_name":<String_value> }}

Response Payload: JSON

{ "virtual_ip_addresses":[{ "is_private":<Boolean_value>

, "is_identity":<Boolean_value> , "package_name":<String_value> , "is_auto":<Boolean_value> , "virtual_interface_name":<String_value> , "ip_address":<String_value> , "id":<Integer_value> , "site_name":<String_value> }]}