Port Management for HA Constitution FW/UTM


Overview

This API enables users to execute port management for FW or UTM with high availability setup. This API works as asynchronous and the users are required to execute another API (see Get Port Management Status ) to check status of the port management.


Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/ecl-api/ports/utm/ha/{deviceid}?tenantid={tenantid}&usertoken={x-subject-token}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
Parameter Type Format Description Required
tenantid String UUID Tenant ID of the owner (UUID) Yes
usertoken String UUID User Token (UUID) Yes
deviceid String - msa_device_id (MSA Device External reference). Devices upgraded from Version1 to Version2 will be changed to the value NCSxxxx instead of CESxxxx. Yes

Request Body Parameter

Request Parameters
Parameter Type Format Description Required
enable_port String Boolean true to enable the port false to disable the port Yes
ip_address String IP Addresses(Array) IP Addresses of the port Yes, if enabling the port
network_id String UUID Network Id to which the port is associated on Openstack Yes, if enabling the port
subnet_id String UUID Subnet Id to which the port is associated on Openstack Yes, if enabling the port
mtu String Numeric MTU value to configure Yes, if enabling the port
comment String - Comments for the port Yes, if enabling the port,but can be blank
enable_ping String Boolean true to enable ping response, false to disable ping response Yes, if enabling the port
vrrp_grp_id String Numeric [1-100] VRRP Group ID Yes, if enabling the port
vrrp_id String Numeric [1-100] VRRP ID Yes, if enabling the port
vrrp_ip String IP Address IP Address of the port Yes, if enabling the port
preempt String Boolean true to enable preempt option, false to disable preempt option Yes, if enabling the port

Sample Request Body

{
    "port": [{
            "enable_port": "true",
            "ip_address": ["10.0.0.1/24","10.0.0.2/24"],
            "network_id": "741e6848-2b1a-4a49-af80-aca4bc1dc6a3",
            "subnet_id": "3df306f6-e1e2-461e-ae17-b358475a0baa",
            "mtu": "1300",
            "comment": "comments here",
            "enable_ping": "true",
            "vrrp_grp_id": "20",
            "vrrp_id": "21",
            "vrrp_ip": "10.0.0.3",
            "preempt": "true"
        }]
}

Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Bad Request
401 Unauthorized
404 Not Found
405 Method Not Allowed
500 Internal Server Error

Response Parameter

Response Parameters
Parameter Type Format Description
message String - Message of the response
processId String Numeric Process ID of the execution, this number is necessary to check the status of port management

Sample Response Body

Normal Response

{
    "message":"The process launch request has been accepted",
    "processId":"209561"
}

Error Response

{
    "error": {
         "message": "error message"
    }
}
Port Management for Single Constitution FW/UTM
Port Management for WAF