[Firewall Rule] editFirewall

editFirewall

Summary of the Process by the Function

Edits firewall rules which are set in network interface of a specific server.

Request Parameters

Specify the following parameter(s) when executing this function.

ParameterDescriptionRequired
Identifier

VM identifier

Specifies the identifier of the virtual server
The virtual server identifier can be obtained through 4.1. listNodes function
It is the identifier in the response object, 4.1. listNodes function

Address

IP address

In order to change source address set in the relevant firewall rule, specify the new IP address, the value after the change
・ When this field value is NULL, it will be applied to all the IP addresses
・ When specifying IP address range, connect IP addresses by hyphen
(Example: 192.168.1.1-192.168.1.10)
・ When specifying IP address by CIDR, separate by slash
(Example: 192.168.1.1/24)

command

Command

In order to change the command which is set to execute in the relevant firewall rule, specify a command after the change as ACCEPT or DROP

firewall_id

Firewall ID

Specifies the ID allocated to the relevant firewall rule
The firewall rule ID can be obtained through 7.1. listNetworkInterfaces function
It is the id in the response object, 7.1. listNetworkInterfaces function

network_interface_id

Network interface ID

Specifies network interface ID on which the target firewall rule will be set
The network interface ID can be obtained through 7.1. listNetworkInterfaces function
It is the id in the response object, 7.1. listNetworkInterfaces function

port

Port

In order to change the port to send set in the relevant firewall rule, specify the new port to send, the value after the change
・ When this parameter is not specified or its value is NULL, it will be applied to all the ports
・ When specifying by port range, connect port numbers by colon
(Example: 1024:1028)
・ When specifying more than one non-consequtive ports, separate them by comma
(Example: 80,443,21)

×
protocol Protocol
Specifies the new protocol type after the change in order to change the protocol type set on the relevant firewall rule as TCP or UDP
×

Response Objects

If the request to edit the specified firewall rules is successful then true is returned.
If the request to edit the specified firewall rules failed then the resulting error message is returned.

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=editFirewall&AccessKeyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&address=192.168.0.100%2F32&command=DROP&port=3&protocol=TCP&firewall_id=ID_of_Firewall-rule&Signature=Signature

Response Sample

true

Note: GMO CLOUD AMERICA INC. does not make any guarantee with regard to the content of this manual and will not be held responsible for any damages resulting from customers or third parties.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk