Port Management for WAF¶
Overview¶
This API enables users to execute port management for WAF. 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.
Request¶
HTTP Request Path¶
{endpoint}/ecl-api/ports/waf/{deviceid}?tenantid={tenantid}&usertoken={x-subject-token}
Request Parameter¶
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¶
Parameter | Type | Format | Description | Required |
---|---|---|---|---|
enable_port | String | Boolean | true to enable the port false to disable the port | Yes |
ip_address | String | IP Address | IP Address 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 |
Sample Request Body¶
{
"port": [{
"enable_port": "true",
"ip_address": "10.0.0.1/24",
"network_id": "741e6848-2b1a-4a49-af80-aca4bc1dc6a3",
"subnet_id": "3df306f6-e1e2-461e-ae17-b358475a0baa",
"mtu": "1300",
"comment": "comments here"
}]
}
Response¶
HTTP Response Code¶
Response Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
405 | Method Not Allowed |
500 | Internal Server Error |