Commands for the ChannelFrameworkManagement group of the AdminTask object

Use the Jython or Jacl scripting languages to configure security. The commands and parameters in the ChannelFrameworkManagement group can be used to create and manage transport channels and transport channel chains.

For more information about the AdminTask object, see the Commands for the AdminTask object article.

The following commands are available for the ChannelFrameworkManagement group of the AdminTask object:

Command name: Description: Target object: Parameters and return values: Examples:
createChain The createChain command creates a new chain of transport channels that are based on a chain template. The instance of the transport channel service under which the new chain is created. (ObjectName, required)

  • Parameters:

    - 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)

  • Returns: The object name of the channel chain that was created.

Batch mode example usage:

  • Using Jacl

    $AdminTask createChain (cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#
    TransportChannelService_1) {-template WebContainer
    (templates/chains|webcontainer-chains.xml#Chain_1) 
    -name trialChain1 }
    

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

  • Using Jython string

      AdminTask.createChain('cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#
    TransportChannelService_1', '[-template "WebContainer
    (templates/chains|webcontainer-chains.xml#Chain_1)" 
    -name trialChain]')
    

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

       

Interactive mode example usage:

  • Using Jacl

    $AdminTask createChain {-interactive}
    

  • Using Jython string

    AdminTask.createChain ('[-interactive]')
    

deleteChain The deleteChain command deletes an existing chain and, optionally, the transport channels in the chain.

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

  • Parameters:

    - deleteChannels

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

  • Returns: None

Batch mode example usage:

  • Using Jacl

    $AdminTask deleteChain trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#Chain_1093554462922)
    

    $AdminTask deleteChain trialChain(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#Chain_1093554378078) {-deleteChannels true}
    

  • Using Jython string

      AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1)')
    

    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1)', '[-deleteChannels true]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask deleteChain {-interactive}
    

  • Using Jython string

    AdminTask.deleteChain ('[-interactive]')
    

listChainTemplates

The listChainTemplates command displays a list of templates that use to create chains in this configuration. All templates have a certain type of transport channel as the last transport channel in the chain. None

  • Parameters:

    - 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)

  • Returns: A list of all the chain template object names. If you specify the acceptorFilter parameter, the list that returns is filtered to match the filter that you specified.

Batch mode example usage:

  • Using Jacl

    $AdminTask listChainTemplates {}
    

    $AdminTask listChainTemplates "-acceptorFilter WebContainerInboundChannel"
    

  • Using Jython string

    AdminTask.listChainTemplates()
    

    AdminTask.listChainTemplates('[-acceptorFilter WebContainerInboundChannel]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask listChainTemplates {-interactive}
    

  • Using Jython string

    AdminTask.listChainTemplates ('[-interactive]')
    

listChains The listChains command lists all the chains that are configured under a particular instance of the transport channel service. The instance of the transport channel service under which the chains are configured. (ObjectName, required)

  • Parameters:

    - acceptorFilter

    The chains that are returned by this parameter will have a transport channel instance of the type that you specify 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 that you specify.(String, optional)

  • Returns: A list of all the channel chain object names that match the specified filters. If no you do not specify any parameters, all of the channel chains that are configured under the particular instance of transport channel service are returned.

Batch mode example usage:

  • Using Jacl

    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328)
    

    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328) {-acceptorFilter 
    WebContainerInboundChannel}
    

    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328) 
    {-endPointFilter WC_adminhost}
    

  • Using Jython string

    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)')
    

    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-acceptorFilter WebContainerInboundChannel]')
    

    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-endPointFilter WC_adminhost]')
    

       

Interactive mode example usage:

  • Using Jacl

    $AdminTask listChains {-interactive}
    

  • Using Jython string

    AdminTask.listChains ('[-interactive]')
    


Related tasks
Using the AdminTask object for scripted administration Related reference
Commands for the AdminTask object