Skip to main content

Configuring Network Topology (Deprecated)

deprecated

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

Topology Types and Descriptions

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

More Details

fwGroupType Descriptions

Group TypeDescription
1Infrastructure machines
2Servers
3Server gateways
4DMZ gateways

Types of groups required for each topology

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

Client Group IDs for the Smart Client group

SmartGroup TypeSmartGroup 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\" />

PropertyValues
displayType0 for Servers 1 for Laptops
encryptTraffic1 to encrypt traffic with https protocol and 0 to disable it
numberOfStreamsParallel data transfer streams for long distance networks (default value is 1, and maximum value is 8).
connectionProtocol1 - Encrypted, 2 - Authenticated, 3 - Regular, 4 - Raw
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

OK


Schema
  • topology object
  • _type_ integer
  • topologyId integer
  • error object
  • errorCode integer
Loading...