CoreGroupBridgeManagement command group for the AdminTask object

You can use the Jython or Jacl scripting languages to manage deployed applications using scripting. The commands and parameters in the CoreGroupBridgeManagement group can be used to create and manage core group access points, TCP inbound channel port, and bridge interfaces. A bridge interface specifies a particular node and server that runs the core group bridge service.

The CoreGroupBridgeManagement command group for the AdminTask object includes the following commands:

createCoreGroupAccessPoint
deleteCoreGroupAccessPoints
exportTunnelTemplate
getNamedTCPEndPoint
importTunnelTemplate
listCoreGroups
listEligibleBridgeInterfaces
removeCoreGroupBridgeInterface

createCoreGroupAccessPoint

The createCoreGroupAccessPoint command creates a default core group access point for the core group that you specify and adds it to the default access point group. If the default access point group does not exist, the command creates a default access point group.

Target object

Core group bridge settings object for the cell. (ObjectName, required).

Required parameters

-coreGroupName: The name of the core group for which the core group access point will be created. (String, required)

Optional parameters

None

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createCoreGroupAccessPoint 
 (cells/cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1) "-coreGroupName core_group_name"

Using Jython string:

AdminTask.createCoreGroupAccessPoint('cells/cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1', 
 '[-coreGroupName core_group_name]')

Using Jython list:

AdminTask.createCoreGroupAccessPoint('cells/cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1', 
 ['-coreGroupName', 'core_group_name'])

Interactive mode example usage:

Using Jacl:

$AdminTask createCoreGroupAccessPoint {-interactive}

Using Jython:

AdminTask.createCoreGroupAccessPoint('-interactive')

deleteCoreGroupAccessPoints

The deleteCoreGroupAccessPoints command deletes all the core group access points that are associated with a group that you specify.

Target object

Core group bridge settings object for the cell. (ObjectName, required)

Required parameters

-coreGroupName: The name of the core group whose core group access points will be deleted. (String, required)

Optional parameters

None

Examples

Batch mode example usage:

Using Jacl:

$AdminTask deleteCoreGroupAccessPoints (cells/cell_name/coregroupbridge.xml# 
 CoreGroupBridgeSettings_1) "-coreGroupName core_group_name"

Using Jython string:

AdminTask.deleteCoreGroupAccessPoints('cells/cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1', 
 '[-coreGroupName core_group_name]')

Using Jython list:

AdminTask.deleteCoreGroupAccessPoints('(cells/ cell_name/coregroupbridge.xml# 
 CoreGroupBridgeSettings_1)', ['-coreGroupName', 'core_group_name'])

Interactive mode example usage:

Using Jacl:

$AdminTask deleteCoreGroupAccessPoints {-interactive}

Using Jython:

AdminTask.deleteCoreGroupAccessPoints('-interactive')

exportTunnelTemplate

The exportTunnelTemplate command exports a tunnel template and its associated children to a simple properties file.

Target object

None

Required parameters

-tunnelTemplateName: Specifies the name of the tunnel template to export. (String, required)
-outputFileName: Specifies the name of the properties file to create. (String, required)

Optional parameters

None

Examples

Batch mode example usage:

Using Jython string:

AdminTask.exportTunnelTemplate('[-tunnelTemplateName tunnelTemplate1 -outputFileName tunnelTemplate1.props]')

Using Jython list:

AdminTask.exportTunnelTemplate(['-tunnelTemplateName', 'tunnelTemplate1', '-outputFileName', 
 'tunnelTemplate1.props'])

Interactive mode example usage:

Using Jython:

AdminTask.exportTunnelTemplate('-interactive')

getNamedTCPEndPoint

The getNamedTCPEndPoint command returns the port associated with the access point group that you specify. The port that is returned is the one that is specified on the TCP inbound channel of the transport channel chain for bridge interface that you specify.

Target object

The bridge interface object for which the port will be listed. (ObjectName, required)

Required parameters

None.

Optional parameters

-bridgeInterface: This parameter is optional, and has limited usage. It indicates that the access point group is a core group bridge interface. Valid values are true and false.

Examples

Batch mode example usage:

Using Jacl:

AdminTask.getNamedTCPEndPoint('cells/cell_name/coregroupbridge.xml#BridgeInterface_2')"-bridgeInterface true"

Using Jython string:

AdminTask.getNamedTCPEndPoint('cells/cell_name/coregroupbridge.xml#BridgeInterface_2','[-bridgeInterface true]')

Using Jython list:

AdminTask.getNamedTCPEndPoint('cells/cell_name/coregroupbridge.xml#BridgeInterface_2') -bridgeInterface

Interactive mode example usage:

Using Jacl:

$AdminTask getNamedTCPEndPoint -bridgeInterface {-interactive}

Using Jython string:

AdminTask.getNamedTCPEndPoint -bridgeInterface ('[-interactive]')

importTunnelTemplate

The importTunnelTemplate command imports a tunnel template and its children to the cell configuration.

Target object

None

Required parameters

-inputFileName: Specifies the name of the tunnel template file to import. (String, required)
-bridegeInterfaceNodeName: Specifies the name of the secure proxy node to use for the core group bridge interface. (String, required)
-bridegeInterfaceServerName: Specifies the name of the secure proxy server to use for the core bridge interface. (String, required)

Optional parameters

None

Examples

Batch mode example usage:

Using Jython string:

AdminTask.importTunnelTemplate('[-inputFileName tunnelTemplate1.props 
 -bridegeInterfaceNodeName secureProxyNode -bridegeInterfaceServerName mySecureProxyServer]')

Using Jython list:

AdminTask.importTunnelTemplate(['-inputFileName', 'tunnelTemplate1.props', 
 '-bridegeInterfaceNodeName', 'secureProxyNode', '-bridegeInterfaceServerName', 'mySecureProxyServer'])

Interactive mode example usage:

Using Jython:

AdminTask.importTunnelTemplate('-interactive')

listCoreGroups

The listCoreGroups command returns a collection of core groups that are related to the core group that you specify.

Target object

The name of the core group for which the related core groups will be listed. (String, required)

Required parameters

-cgBridgeSettings: The group bridge settings object for the cell. (ObjectName, required)

Optional parameters

None

Examples

Batch mode example usage:

Using Jacl:

$AdminTask listCoreGroups DefaultCoreGroup "-cgBridgeSettings 
 (cells/cell_name/coregroupbridge.xml# CoreGroupBridgeSettings_1)"

Using Jython string:

AdminTask.listCoreGroups('DefaultCoreGroup', '[-cgBridgeSetting (cells/ 
 cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1)]')

Using Jython list:

AdminTask.listCoreGroups('DefaultCoreGroup', ['-cgBridgeSetting', '(cells/ 
 cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1)'])

Interactive mode example usage:

Using Jacl:

$AdminTask listCoreGroups {-interactive}

Using Jython:

AdminTask.listCoreGroups('-interactive')

listEligibleBridgeInterfaces

The listEligibleBridgeInterfaces command returns a collection of node, server, and transport channel chain combinations that are eligible to become bridge interfaces for the specified core group access point.

Target object

The core group access point object for which bridge interfaces will be listed. (ObjectName, required)

Required parameters

None

Optional parameters

None

Example output

A set of bridge interfaces. (Set of String) Each bridge interface is represented by a combination of a node, a server and a DCS channel chain: <node name>, <server name>, <DCS Channel Chain objectName. For example, an element of the set returned by this command might look like the following:

node_name dmgr DCS-Secure(cells/cell_name/nodes/node_name/servers/dmgr/server.xml#Chain_4)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask listEligibleBridgeInterfaces 
 CGAP_DCG_2(cells/cell_name/coregroupbridge.xml#CoreGroupAccessPoint_1089636614062)

Using Jython string:

AdminTask.listEligibleBridgeInterfaces('CGAP_DCG_2(cells/cell_name/coregroupbridge.xml# 
 CoreGroupAccessPoint_1089636614062)')

Interactive mode example usage:

Using Jacl:

$AdminTask listEligibleBridgeInterfaces {-interactive}

Using Jython:

AdminTask.listEligibleBridgeInterfaces('-interactive')

removeCoreGroupBridgeInterface

The removeCoreGroupBridgeInterface command removes the specified core group bridge interface from the server that you specify.

Target object

Core group bridge settings object for the cell. (ObjectName, required)

Required parameters

-coreGroupName: The name of the core group for which the bridge interface is being removed. (String required)
-nodeName: The name of the node to which the server, where the bridge interface is being removed, belongs.
-serverName: The name of the server from where the bridge interface is being removed.

Optional parameters

None

Examples

Batch mode example usage:

Using Jacl:

$AdminTask removeCoreGroupBridgeInterface (cells/ 
cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1) 
-coreGroupName DefaultCoreGroup-nodeName node_name -serverName server_name"

Using Jython string:

AdminTask.removeCoreGroupBridgeInterface('cells/ 
cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1', 
'[-coreGroupName DefaultCoreGroup -nodeName node_name -serverName server_name]')

Using Jython list:

AdminTask.removeCoreGroupBridgeInterface('cells/ 
cell_name/coregroupbridge.xml#CoreGroupBridgeSettings_1', 
['-coreGroupName', 'DefaultCoreGroup', '-serverName', 'server_name', '-nodeName', 'node_name']')

Interactive mode example usage:

Using Jacl:

$AdminTask removeCoreGroupBridgeInterface {-interactive}

Using Jython:

AdminTask.removeCoreGroupBridgeInterface ('[-interactive]')

Using Jython list:

AdminTask.removeCoreGroupBridgeInterface (['-interactive'])