Configuring Network Topology (Deprecated)

Select

Customer Managed

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Topology Types and Descriptions

Topology Type	Description
1	Network Gateway Topology
2	One-Way Topology
3	Two-way Topology
4	Cascadng gateways Topology
5	One-way Forwarding Topology

More Details

fwGroupType Descriptions

Group Type	Description
1	Infrastructure machines
2	Servers
3	Server gateways
4	DMZ gateways

Types of groups required for each topology

Topology Type	Required Group Combinations
Type 1	Servers, Infrastructure machines and Server gateways
Type 2	Infrastructure machines and Servers
Type 3	Infrastructure machines and Servers
Type 4	Servers, Infrastructure machines, Server gateways and DMZ Gateways
Type 5	Servers, Infrastructure machines and Server gateways

Client Group IDs for the Smart Client group

SmartGroup Type	SmartGroup ID
My CommServe	-1
My MediaAgents	-2
My CommServe And MediaAgents	-3

More Details on Smart Client Groups

Extended Properties

Extended properties is an XML string embedded in JSON For example : <App_TopologyExtendedProperties displayType=\"0\" encryptTraffic=\"0\" numberOfStreams=\"1\" connectionProtocol=\"2\" />

Property	Values
displayType	0 for Servers 1 for Laptops
encryptTraffic	1 to encrypt traffic with https protocol and 0 to disable it
numberOfStreams	Parallel data transfer streams for long distance networks (default value is 1, and maximum value is 8).
connectionProtocol	1 - Encrypted, 2 - Authenticated, 3 - Regular, 4 - Raw

application/json

Request Body

firewallTopology object required
Firewall topology properties
extendedProperties string
An XML string for additional settings
topologyType integer required
Possible values: [1, 2, 3, 4, 5]
Type of the topology
description string
Topology description
isSmartTopology boolean
A boolean flag if the topology contains a smart client group
firewallGroups object[] required
Firewall groups in the topology
fwGroupType integer required
Possible values: [1, 2, 3, 4]
isMnemonic boolean
True if the group is of a smart clientgroup
clientGroup object required
Client group object - Pass either name or ID
clientGroupName string
Name of the clientGroup
clientGroupId integer
ID of the client group
options object
Additional settings of the firewall group
configureAutomatically boolean
Flag if the options has to be set automatically
tunnelConnectionPort integer
Edit Tunnel connection port of clients in the client group
keepAliveSeconds integer
Edit the KeepAliveSeconds interval in seconds of the clients in
topologyEntity object required
topologyName string
Name of the topology
pushNWConfigOnTopology boolean
Flag to push network configuration for the clients in the topology

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

topology object
_type_ integer
topologyId integer
error object
errorCode integer

{
  "topology": {
    "_type_": 0,
    "topologyId": 0
  },
  "error": {
    "errorCode": 0
  }
}

{
  "topology": {
    "_type_": 156,
    "topologyId": 1086
  },
  "error": {
    "errorCode": 0
  }
}

Configuring Network Topology (Deprecated)​

Topology Types and Descriptions​

fwGroupType Descriptions​

Types of groups required for each topology​

Client Group IDs for the Smart Client group​

Extended Properties​