ChannelFrameworkManagement

The commands and parameters in the ChannelFrameworkManagement group can be used to manage transport channels and transport channel chains.

The ChannelFrameworkManagement commands include:

• createChain
• deleteChain
• listChainTemplates
• listChains

createChain

Create a new chain of transport channels that are based on a chain template.

Target object: The instance of the transport channel service under which the new chain is created. (ObjectName, required)

Required parameters and return values

-template

The chain template on which to base the new chain. (ObjectName, required)

-name

The name of the new chain. (String, required)

-endPoint

The name of the end point to be used by the instance of the TCP inbound channel in the new chain if the chain is an inbound chain. (ObjectName, optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createChain (cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml# TransportChannelService_1) {-template WebContainer (templates/chains|webcontainer-chains.xml#Chain_1) -name trialChain1 }
  $AdminTask createChain (cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml# TransportChannelService_1) {-template WebContainer (templates/chains|webcontainer-chains.xml#Chain_1) -name trialChain1 -endPoint (cells/rohitCell01/ nodes/rohitCellMgr01|serverindex.xml#EndPoint_3) }

• Jython string:
  AdminTask.createChain('cells/rohitCell01/nodes/ rohitCellMgr01/servers/dmgr|server.xml# TransportChannelService_1', '[-template "WebContainer (templates/chains|webcontainer-chains.xml#Chain_1)" -name trialChain]')
  AdminTask.createChain('cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1', '[-template "WebContainer(templates/chains|webcontainer-chains. xml#Chain_1)" -name trialChain -endPoint "(cells/rohitCell01/nodes/rohitCellMgr01|serverindex.xml#EndPoint_3)"]')

• Jython list:
  AdminTask.createChain('cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml# TransportChannelService_1', ['-template', "WebContainer (templates/chains|webcontainer-chains.xml#Chain_1)", '-name', 'trialChain'])
  AdminTask.createChain('cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1', ['-template', "WebContainer(templates/chains|webcontainer-chains.xml#Chain_1)", '-name', 'trialChain', '-endPoint', "(cells/rohitCell01/nodes/rohitCellMgr01|serverindex.xml#EndPoint_3)"])

Interactive mode example usage:

• Jacl:
  $AdminTask createChain {-interactive}

• Jython string:
  AdminTask.createChain ('[-interactive]')

• Jython list:
  AdminTask.createChain (['-interactive'])

deleteChain

Deletes an existing chain and, optionally, the transport channels in the chain.

Target object:

The chain to be deleted. (Object name, required)

Required parameters and return values

-deleteChannels

If the value of this attribute is true, non-shared transport channels used by the specified chain will be deleted. (Boolean, optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask deleteChain trialChain1(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr |server.xml#Chain_1093554462922)
  $AdminTask deleteChain trialChain(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr |server.xml#Chain_1093554378078) {-deleteChannels true}

• Jython string:
  AdminTask.deleteChain('trialChain1(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1)')
  AdminTask.deleteChain('trialChain1(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1)', '[-deleteChannels true]')

• Jython list:
  AdminTask.deleteChain('trialChain1(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1)')
  AdminTask.deleteChain('trialChain1(cells/rohitCell01/nodes/rohitCellMgr01/servers/dmgr|server.xml#TransportChannelService_1)', ['-deleteChannels', 'true'])

Interactive mode example usage:

• Jacl:
  $AdminTask deleteChain {-interactive}

• Jython string:
  AdminTask.deleteChain ('[-interactive]')

• Jython list:
  AdminTask.deleteChain (['-interactive'])

listChainTemplates

Display a list of templates we can use to create chains in this configuration. All templates have a certain type of transport channel as the last transport channel in the chain.

Target object:

None

Required parameters and return values

-acceptorFilter

The templates returned by this method all have a transport channel instance of the specified type as the last transport channel in the chain. (String, optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listChainTemplates {}
  $AdminTask listChainTemplates "-acceptorFilter WebContainerInboundChannel"

• Jython string:
  AdminTask.listChainTemplates()
  AdminTask.listChainTemplates('[-acceptorFilter WebContainerInboundChannel]')

• Jython list:
  AdminTask.listChainTemplates()
  AdminTask.listChainTemplates(['-acceptorFilter', 'WebContainerInboundChannel'])

Interactive mode example usage:

• Jacl:
  $AdminTask listChainTemplates {-interactive}

• Jython string:
  AdminTask.listChainTemplates ('[-interactive]')

• Jython list:
  AdminTask.listChainTemplates (['-interactive'])

listChains

List all the chains configured under a particular instance of the transport channel service.

Target object:

The instance of the transport channel service under which the chains are configured. (ObjectName, required)

Required parameters and return values

-acceptorFilter

The chains that are returned by this parameter will have a transport channel instance of the type specified as the last transport channel in the chain. (String, optional)

-endPointFilter:

The chains returned by this parameter will have a TCP inbound channel using an end point with the name specified.(String, optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listChains (cells/rohitCell01/nodes/ rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)
  $AdminTask listChains (cells/rohitCell01/nodes/ rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328) {-acceptorFilter WebContainerInboundChannel}
  $AdminTask listChains (cells/rohitCell01/nodes/ rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328) {-endPointFilter WC_adminhost}

• Jython string:
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)')
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-acceptorFilter WebContainerInboundChannel]')
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-endPointFilter WC_adminhost]')

• Jython list:
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)')
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', ['-acceptorFilter', 'WebContainerInboundChannel'])
  AdminTask.listChains('(cells/rohitCell01/nodes/rohitNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', ['-endPointFilter', 'WC_adminhost'])

Interactive mode example usage:

• Jacl:
  $AdminTask listChains {-interactive}

• Jython string:
  AdminTask.listChains ('[-interactive]')

• Jython list:
  AdminTask.listChains (['-interactive'])

wsadmin AdminTask

Commands for the AdminTask object