Commands for the NodeGroupCommands group of the AdminTask object

Use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the NodeGroupCommands group can be used to create and manage node groups and node group members.

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

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

Command name: Description: Target object: Parameters and return values: Examples:

addNodeGroupMember

The addNodeGroupMember command adds a member to a node group. Nodes can be members of more than one node group. The command does validity checking to ensure the following:

  • Distributed and z/OS nodes are not combined in the same node group.

  • z/OS platform from different sysplexs are not combined into the same node group.

The target object is the node group where the member will be created. This target object is required.

  • Parameters:

    - nodeName

    The name of the node that you want to add to a node group. This parameter is required.

  • Returns: Node group member object ID

Batch mode example usage:

  • Using Jacl

    $AdminTask addNodeGroupMember WBINodeGroup {-nodeName WBINode}
    

  • Using Jython string

    AdminTask.addNodeGroupMember('WBINodeGroup', '[-nodeName WBINode]')
    
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask addNodeGroupMember {-interactive}
    

  • Using Jython string

    AdminTask.addNodeGroupMember ('[-interactive]')
    

createNodeGroup

The createNodeGroup command creates a new node group. A node group consists of a group of nodes that are referred to as node group members. Optionally, you can create a short name and a description for the new node group. The node group name to be created. This target object is required.

  • Parameters:

    - shortName

    The short name of the node group. This parameter is optional.

    - description

    The description of the node group. This parameter is optional.

  • Returns: The node group object ID.

Batch mode example usage:

  • Using Jacl

    $AdminTask createNodeGroup WBINodeGroup
    

  • Using Jython string

    AdminTask.createNodeGroup('WBINodeGroup')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask createNodeGroup {-interactive}
    

  • Using Jython string

    AdminTask.createNodeGroup ('[-interactive]')
    

createNodeGroupProperty

The createNodeGroupProperty command creates custom properties for a node group. The name of the node group. This target object is required.

  • Parameters:

    - name

    The name of the custom property to create. This parameter is required.

    - value

    The value of the custom property. This parameter is optional.

    - description

    The description of the custom property. This parameter is optional.

  • Returns: The properties object ID.

Batch mode example usage:

  • Using Jacl

    $AdminTask createNodeGroupProperty WBINodeGroup 
    {-name Channel -value "channel1"}
    

  • Using Jython string

    AdminTask.createNodeGroupProperty('WBINodeGroup', 
    '[-name Channel -value channel1]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask createNodeGroupProperty {-interactive}
    

  • Using Jython string

    AdminTask.createNodeGroupProperty ('[-interactive]')
    

listNodeGroupProperties

The listNodeGroupProperties command displays all of the custom properties of a node group. The target object is name of the node group. This target object is required.

  • Parameters: None

  • Returns: A list of all of the custom properties of a node group.

Batch mode example usage:

  • Using Jacl

    $AdminTask listNodeGroupProperties WBINodeGroup
    

  • Using Jython string

    AdminTask.listNodeGroupProperties('WBINodeGroup')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask listNodeGroupProperties {-interactive}
    

  • Using Jython string

    AdminTask.listNodeGroupProperties ('[-interactive]')
    

listNodeGroups

The listNodeGroups command returns the list of node groups from the configuration repository. You can pass an optional node name to the command that returns the list of node groups where the node resides. The target object is name of the node. This target object is optional.

  • Parameters: None

  • Returns: A list of the node groups in the cell.

Batch mode example usage:

  • Using Jacl

    $AdminTask listNodeGroups
    
    $AdminTask listNodeGroups nodeName
    

  • Using Jython string

    AdminTask.listNodeGroups 
    
    AdminTask.listNodeGroups('nodeName')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask listNodeGroups {-interactive}
    

  • Using Jython string

    AdminTask.listNodeGroups ('[-interactive]')
    

listNodes The listNodes command displays all of the nodes in the cell. The target object is name of the node group. This target object is optional.

  • Parameters: None

  • Returns: A list of all the nodes in the cell

Batch mode example usage:

  • Using Jacl

    $AdminTask listNodes
    

  • Using Jython string

    AdminTask.listNodes()
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask listNodes {-interactive}
    

  • Using Jython string

    AdminTask.listNodes ('[-interactive]')
    

modifyNodeGroup

The modifyNodeGroup command modifies the configuration of a node group. The node group name cannot be changed. However, its short name and description are supported. Also, its node membership can be modified. The target object is the node group name. This target object is required.

  • Parameters:

    - shortName

    The short name of the node group. This parameter is optional.

    - description

    The description of the node group. This parameter is optional.

  • Returns: Node group object ID.

Batch mode example usage:

  • Using Jacl

    $AdminTask modifyNodeGroup WBINodeGroup 
    {-shortName WBIGroup -description "Default node group"}
    

  • Using Jython string

    AdminTask.modifyNodeGroup WBINodeGroup
    ('[-shortName WBIGroup -description "WBI" node group]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask modifyNodeGroup {-interactive}
    

  • Using Jython string

    AdminTask.modifyNodeGroup ('[-interactive]')
    

modifyNodeGroupProperty

The modifyNodeGroupProperty command modifies custom properties for a node group The name of the node group. This target object is required.

  • Parameters:

    - name

    The name of the custom property to modify. This parameter is required.

    - value

    The value of the custom property. This parameter is optional.

    - description

    The description of the custom property. This parameter is optional.

  • Returns: Properties object ID

Batch mode example usage:

  • Using Jacl

    $AdminTask modifyNodeGroupProperty WBINodeGroup 
    {-name Channel -value "channel1"}
    

  • Using Jython string

    AdminTask.modifyNodeGroupProperty('WBINodeGroup', 
    '[-name Channel -value channel1]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask modifyNodeGroupProperty {-interactive}
    

  • Using Jython string

    AdminTask.modifyNodeGroupProperty ('[-interactive]')
    

removeNodeGroup

The removeNodeGroup command removes the configuration of a node group. You can remove a node group if it does not contain any members. Also, the default node group cannot be removed. The name of the node group to be removed. This target object is required.

  • Parameters: None

  • Returns: The node group object ID.

Batch mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroup WBINodeGroup
    

  • Using Jython string

    AdminTask.removeNodeGroup('WBINodeGroup')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroup {-interactive}
    

  • Using Jython string

    AdminTask.removeNodeGroup ('[-interactive]')
    

removeNodeGroupMember

The removeNodeGroupMember command removes the configuration of a node group member.

  • A node must always be a member of at least one node group.

  • You cannot remove a node from a node group that is part of a cluster in that node group.

The target object is the node group containing the member to be removed. This target object is required.

  • Parameters:

    - nodeName

    The name of the node to remove from a node group. This parameter is required.

  • Returns: Node group member object ID.

Batch mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroupMember WBINodeGroup {-nodeName WBINode} 
    

  • Using Jython string

    AdminTask.removeNodeGroupMember('WBINodeGroup', '[-nodeName WBINode]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroupMember {-interactive}
    

  • Using Jython string

    AdminTask.removeNodeGroupMember ('[-interactive]')
    

removeNodeGroupProperty

The removeNodeGroupProperty command removes custom properties of a node group. The name of the node group. This target object is required.

  • Parameters:

    - name

    The name of the custom property to remove. This parameter is required.

  • Returns: Properties object ID

Batch mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroupProperty WBINodeGroup {-name Channel}
    

  • Using Jython string

    AdminTask.removeNodeGroupProperty('WBINodeGroup', '[-name Channel]')
    

Interactive mode example usage:

  • Using Jacl

    $AdminTask removeNodeGroupProperty {-interactive}
    

  • Using Jython string

    AdminTask.removeNodeGroupProperty ('[-interactive]')
    


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