DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

VPC Firewall

CreateVpcFirewall

Creates a VPC firewall. For example,
CreateVpcFirewall name=name vpcUuid=27e1a95342083ce4a790d4f9dcf7f9bd

Parameters

Name Description Optional Valid Value Starting Version
vpcUuid The VPC vRouter UUID. 4.0.0
description The detailed description of the resource. Yes 3.6.0
name The resource name. 3.6.0
resourceUuid Yes 3.6.0
tagUuids The tag UUID list. Yes 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

QueryVpcFirewall

Queries a VPC firewall. For example,
QueryVpcFirewall vpcUuid=27e1a95342083ce4a790d4f9dcf7f9bd

Primitive Fields of Query

See VPC Firewall Inventory.

UpdateVpcFirewall

Updates a VPC firewall. For example,
UpdateVpcFirewall uuid=27e1a95342083ce4a790d4f9dcf7f9bd

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
description The detailed description of the resource. Yes 3.6.0
name The resource name. Yes 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

RefreshFirewall

Refreshes the firewall configuration. For example,
RefreshFirewall uuid=178e23cc9fdc3673b90ee258fe60395f

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

DeleteFirewall

Deletes a firewall. For example,
DeleteFirewall uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
deleteMode The deletion mode. Yes
  • Permissive
  • Enforcing
 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

CreateFirewallRuleSet

Creates a firewall rule set. For example,
CreateFirewallRuleSet name=name vpcFirewallUuid=8a91b3fb063335a9b6578c251d61127f actionType=drop

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 3.6.0
vpcFirewallUuid 3.6.0
actionType
  • drop
  • accept
  • reject
 3.6.0
description The detailed description of the resource. Yes 3.6.0
resourceUuid Yes 3.6.0
tagUuids Yes 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

QueryFirewallRuleSet

Queries a firewall rule set. For example,
QueryFirewallRuleSet

Primitive Fields of Query

See Firewall Rule Set Inventory.

UpdateFirewallRuleSet

Updates a firewall rule set. For example,
UpdateFirewallRuleSet uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
name The resource name. Yes 3.6.0
description The detailed description of the resource. Yes 3.6.0
actionType Yes
  • drop
  • accept
  • reject
 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

DeleteFirewallRuleSet

Deletes a firewall rule set. For example,
DeleteFirewallRuleSet uuid=62b6ef32f6573f01929c5020d976bd66

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
deleteMode The deletion mode. Yes
  • Permissive
  • Enforcing
 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

AttachFirewallRuleSetToL3

Attaches a firewall rule set to an L3 network. For example,
AttachFirewallRuleSetToL3 vpcFirewallUuid=d5a0a7ce8bdf315a87189bb3f1c12f98 l3Uuid=ad2bbeb82973334fa0ab243f52088fea forward=in ruleSetUuid=91e9fed42a113c0395a81920c4179a43

Parameters

Name Description Optional Valid Value Starting Version
vpcFirewallUuid 3.6.0
l3Uuid 3.6.0
forward
  • in
  • out
 3.6.0
ruleSetUuid 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

DetachFirewallRuleSetFromL3

Detaches a firewall rule set from an L3 network. For example,
DetachFirewallRuleSetFromL3 vpcFirewallUuid=d5a0a7ce8bdf315a87189bb3f1c12f98 ruleSetUuid=a54a917869733b5590053eb3f4505089 l3Uuid=ad2bbeb82973334fa0ab243f52088fea forward=in

Parameters

Name Description Optional Valid Value Starting Version
vpcFirewallUuid 3.6.0
l3Uuid The L3 network UUID. 4.0.0
forward
  • in
  • out
 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

QueryFirewallRuleSetL3Ref

Queries the reference between a firewall rule set and an L3 network. For example, 
QueryFirewallRuleSetL3Ref

Primitive Fields of Query

See Firewall Rule Set and L3 Network Reference Inventory.

CreateFirewallRule

Creates a firewall rule. For example,
CreateFirewallRule vpcFirewallUuid=889eefa6645739f6a54cea4cfc73c9f6 ruleSetUuid=b8febfb4550f3323b4e645e05516ea4a action=accept ruleNumber=1001.0 state=disable

Parameters

Name Description Optional Valid Value Starting Value
vpcFirewallUuid 3.6.0
ruleSetUuid 3.6.0
action
  • drop
  • accept
 3.6.0
protocol Yes 3.6.0
destPort Yes 3.6.0
sourcePort Yes 3.6.0
sourceIp Yes 3.6.0
destIp Yes 3.6.0
allowStates Yes 3.6.0
tcpFlag Yes 3.6.0
icmpTypeName Yes 3.6.0
ruleNumber 3.6.0
enableLog Yes 3.6.0
state
  • enable
  • disable
 3.6.0
description The detailed description of the resource. Yes 3.6.0
resourceUuid Yes 3.6.0
tagUuids The tag UUID. Yes 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

CreateFirewallRuleFromConfigFile

Create a firewall rule from a configuration file. For example,
CreateFirewallRuleFromConfigFile ruleInfo=[{"ruleNumber":1004,"action":"accept","allowStates":"new,established,invalid,related","protocol":"ICMP","tcpFlag":null,"icmpTypeName":"echo-reply","sourcePort":null,"destPort":null,"sourceIp":"192.168.0.41","destIp":"192.168.0.50","description":null,"state":"disable", "ruleSetUuid": "${defaultRuleSet.uuid}"}]

Parameters

Name Description Optional Valid Value Starting Version
ruleInfo The firewall rule information. 4.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.4.0
timeout 是

QueryFirewallRule

Queries a firewall rule. For example,
QueryFirewallRule

Primitive Fields of Query

See Firewall IP Set Template Inventory.

UpdateFirewallRule

Updates a firewall rule. For example,
UpdateFirewallRule vpcFirewallUuid=07a45d49ddfb3be1b0b36a0022d69598 ruleSetUuid=ff7b94bb9f0432a4a2e411a187138ba0 uuid=b86c9016b4f24953a9edefb53ca0678c action=accept ruleNumber=1001.0 state=disable

Parameters

Name Description Optional Valid Value Starting Version
vpcFirewallUuid 3.6.0
ruleSetUuid 3.6.0
uuid 3.6.0
action
  • drop
  • reject
  • accept
 3.6.0
protocol Yes 3.6.0
destPort Yes 3.6.0
sourcePort Yes 3.6.0
sourceIp Yes 3.6.0
destIp Yes 3.6.0
allowStates Yes 3.6.0
tcpFlag Yes 3.6.0
icmpTypeName Yes 3.6.0
ruleNumber 3.6.0
enableLog Yes 3.6.0
state
  • enable
  • disable
 3.6.0
description The detailed description of the resource. Yes 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

DeleteFirewallRule

Deletes a firewall rule. For example,
DeleteFirewallRule uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
deleteMode The deletion mode. Yes
  • Permissive
  • Enforcing
 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

ChangeFirewallRuleState

Changes the state of a firewall rule. For example,
ChangeFirewallRuleState uuid=08e3e33431173c55a2b71a94ef8e9f2e state=disable

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
state
  • enable
  • disable
 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
timeout Yes

CheckFirewallRuleConfigFile

Checks whether the firewall rule configuration file is valid. For example,
CheckFirewallRuleConfigFile ruleInfo=[{"ruleNumber":1004,"action":"accept","allowStates":"new,established,invalid,related","protocol":"ICMP","tcpFlag":null,"icmpTypeName":"echo-reply","sourcePort":null,"destPort":null,"sourceIp":"192.168.0.41","destIp":"192.168.0.50","description":null,"state":"disable", "ruleSetUuid": "${defaultRuleSet.uuid}"}]

Parameters

Name Description Optional Valid Value Starting Version
ruleInfo The firewall rule information. 4.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.4.0
timeout 是

CreateFirewallRuleTemplate

Creates a firewall rule template. For example,
CreateFirewallRuleTemplate name=template ruleNumber=13 action=accept

Parameters

Name Description Optional Valid Value Starting Version
action
  • drop
  • reject
  • accept
 4.0.0
protocol Yes 4.0.0
name The template name. 4.0.0
destPort Yes 4.0.0
sourcePort Yes 4.0.0
sourceIp Yes 4.0.0
destIp Yes 4.0.0
allowStates Yes 4.0.0
tcpFlag Yes 4.0.0
icmpTypeName Yes 4.0.0
ruleNumber 4.0.0
enableLog Yes 4.0.0
state Yes 4.0.0
description The detailed description of the template. Yes 4.0.0
resourceUuid The template UUID. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

DeleteFirewallRuleTemplate

Deletes a firewall rule template. For example,
DeleteFirewallRuleTemplate uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name Description Optional Valid Value Starting Version
uuid The template UUID. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

UpdateFirewallRuleTemplate

Updates a firewall rule template. For example,
UpdateFirewallRuleTemplate uuid=b86c9016b4f24953a9edefb53ca0678c name=temple action=drop

Parameters

Name Description Optional Valid Value Starting Version
uuid The template UUID. 4.0.0
name The template name. 4.0.0
action
  • drop
  • reject
  • accept
 4.0.0
protocol Yes 4.0.0
destPort Yes 4.0.0
sourcePort Yes 4.0.0
sourceIp Yes 4.0.0
destIp Yes 4.0.0
allowStates Yes 4.0.0
tcpFlag Yes 4.0.0
icmpTypeName Yes 4.0.0
ruleNumber 4.0.0
enableLog Yes 4.0.0
state Yes 4.0.0
description The detailed description of the template. Yes 4.0.0
resourceUuid The template UUID. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

QueryFirewallRuleTemplate

Queries firewall rule templates. For example,
QueryFirewallRuleTemplate

Primitive Fields of Query

See Firewall IP Set Template Inventory.

QueryVpcFirewallVRouterRef

Queries the reference between a firewall and a single node router. For example,
QueryVpcFirewallVRouterRef

Primitive Fields of Query

See VPC Firewall and vRouter Reference Inventory.

ApplyRuleSetChanges

Apply ruleset changes to VPC vRouters. For example,
ApplyRuleSetChanges uuid=e78b0b5ebe1c33159b0faa2d88a41b21

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the ruleset. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

CreateFirewallIpSetTemplate

Creates a firewall IP set or port set template. For example,
CreateFirewallIpSetTemplate name=template type=ip

Parameters

Name Description Optional Valid Value Starting Version
name The template name. 4.0.0
sourceValue Yes 4.0.0
destValue Yes 4.0.0
type 4.0.0
resourceUuid The template UUID. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

DeleteFirewallIpSetTemplate

Deletes a firewall IP set or port set template. For example,
DeleteFirewallIpSetTemplate uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name Description Optional Valid Value Starting Version
uuid The template UUID. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

UpdateFirewallIpSetTemplate

Updates a firewall IP set or port set template. For example,
UpdateFirewallIpSetTemplate name=template ruleNumber=13 action=accept

Parameters

Name Description Optional Valid Value Starting Version
uuid String 4.0.0
name The template name. Yes 4.0.0
sourceValue Yes 4.0.0
destValue Yes 4.0.0
type 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

QueryFirewallIpSetTemplate

Queries a firewall IP set or port set template. For example,
QueryFirewallIpSetTemplate

Primitive Fields of Query

See Firewall IP Set Template Inventory.

PreviousDetachNetworkServiceFromL3NetworkNextSecurity Group
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center