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

Netflow

CreateFlowCollector

Creates a flow collector for a flow meter. For example,
CreateFlowCollector flowMeterUuid=93adc3c5f9c03d3d9aa24cd78bf77d0f

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. Yes 3.6.0
description The detailed description of the resource. Yes 3.6.0
flowMeterUuid The flow meter UUID. 3.6.0
server The IP address of the flow collector. Yes 3.6.0
port The port of the flow collector. Yes 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

QueryFlowCollector

Queries a flow collector of a flow meter. For example,
QueryFlowCollector

Primitive Fields of Query

See Flow Collector Inventory.

UpdateFlowCollector

Updates a flow collector. For example,
UpdateFlowCollector uuid=93adc3c5f9c03d3d9aa24cd78bf77d0f

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
server The IP address of the flow collector. Yes 3.6.0
port The UDP port. 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

DeleteFlowCollector

Deletes a flow collector. For example,
DeleteFlowCollector uuid=4a09dc60a4be305b8a6b1157eedb61bb

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
deleteMode 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

CreateFlowMeter

Creates a flow meter. For example,
CreateFlowMeter type=NetFlow

Parameters

Name Description Optional Valid Value Starting Version
version The version of the flow meter protocol. Yes
  • V5
  • V9
 3.6.0
type The type of the flow meter protocol.
  • NetFlow
  • sFlow
 3.6.0
sample The sample rate of the flow meter. Yes 3.6.0
generateInterval The time interval that the flow meter sends the data packets to the flow collector. Yes 3.6.0
name The resource name. Yes 3.6.0
description The detailed description of the resource. Yes 3.6.0
server The IP address of the flow collector. Yes 3.6.0
port The UDP port of the flow collector. Yes 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
Note:
  • When you create a flow meter resource in ZStack Cloud, you can specify the expiration interval of the flow by adding the FLOW_EXPIRE_INTERVAL option to SystemTags. The SystemTag is passed by using the expireInterval parameter.
    • Format of the FLOW_EXPIRE_INTERVAL option: expireInterval::xx. Here, the unit of xx is second.
    • Example: expireInterval::1200
  • When you create a flow meter resource in ZStack Cloud, you can specify the timeout configuration of the flow by adding the FLOW_ACTIVE_TIMEOUT option to SystemTags. The SystemTag is passed by using the activeTimeout parameter.
    • Format of the FLOW_ACTIVE_TIMEOUT option: activeTimeout::xx. Here, the unit of xx is second.
    • Example: activeTimeout::3600

QueryFlowMeter

Queries a flow meter. For example, 
QueryFlowMeter

Primitive Fields of Query

See Flow Meter Inventory.

UpdateFlowMeter

Updates the information about a flow meter. For example,
UpdateFlowMeter uuid=40175d4f6adc33b69926219a69318de4

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
version The version of the flow meter protocol. Yes
  • V5
  • V9
 3.6.0
sample The sample rate of the flow meter. Yes 3.6.0
name The resource name. Yes 3.6.0
expireInterval The expiration interval of the flow. Yes 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

DeleteFlowMeter

Deletes a flow meter. For example,
DeleteFlowMeter uuid=3a65b90e4cbc30b9b90c6defa9d4150d

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.6.0
deleteMode 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

AddVRouterNetworksToFlowMeter

Adds a VPC vRouter network to a flow meter. For example,
AddVRouterNetworksToFlowMeter flowMeterUuid=f01fef876e503331a4d6b186c41ef1d1 vRouterUuid=335d1d3f24c132dba22362dbb4867c7a l3NetworkUuid=80b4e4931a8a3760bde3d66f1c03a1ae

Parameters

Name Description Optional Valid Value Starting Version
flowMeterUuid The flow meter UUID. 3.6.0
vRouterUuid The VPC vRouter UUID or VPC vRouter group UUID. 3.6.0
l3NetworkUuids The UUID of the VPC vRouter network. 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

QueryVRouterFlowMeterNetwork

Queries a VPC vRouter that enables a flow meter. For example,
QueryVRouterFlowMeterNetwork

Primitive Fields of Query

See vRouter Flow Meter Network Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
flowMeter Flow Meter Inventory The flow meter resource. 3.6.0
l3Network L3 Network Inventory The L3 network. 3.6.0
vRouter vRouter Inventory The vRouter. 3.6.0

GetVRouterFlowCounter

Obtains the statistics information about a flow meter. For example,
GetVRouterFlowCounter vRouterUuid=eee5bf613b913040b6609c2b07efea07

Parameters

Name Description Optional Valid Value Starting Version
vRouterUuid The vRouter 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

RemoveVRouterNetworksFromFlowMeter

Removes a flow meter from a VPC vRouter network. For example,
RemoveVRouterNetworksFromFlowMeter uuids=aaa9d2325b073fd39a7f1a67b007b1ae

Parameters

Name Description Optional Valid Value Starting Version
uuids 3.6.0
deleteMode 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

GetFlowMeterRouterId

Obtains a system router ID used by a flow meter protocol. For example,
GetFlowMeterRouterId vRouterUuid=7ca3752b57ef3c8c89257e1eeb720b88

Parameters

Name Description Optional Valid Value Starting Version
vRouterUuid The VPC vRouter 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

SetFlowMeterRouterId

Sets a VPC vRouter ID used by a flow meter protocol. For example,
SetFlowMeterRouterId vRouterUuid=0bfa81935a6c3dd1a8c68de1874e8a1d routerId=120.0

Parameters

Name Description Optional Valid Value Starting Version
vRouterUuid 3.6.0
routerId The router ID. 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
PreviousIPsecNextPort Mirroring
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center