NodeGroupCommands command group for the AdminTask object

 

+

Search Tips   |   Advanced Search

 

You can 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. The NodeGroupCommands command group for the AdminTask object includes the following commands:

• addNodeGroupMember
• createNodeGroup
• createNodeGroupProperty
• listNodeGroupProperties
• listNodeGroups
• listNodes
• modifyNodeGroup
• modifyNodeGroupProperty
• removeNodeGroup
• removeNodeGroupMember
• removeNodeGroupProperty

 

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.

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

Parameters and return values

-nodeName

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addNodeGroupMember WBINodeGroup {-nodeName WBINode}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask addNodeGroupMember {-interactive}
  

• Use Jython string:

  AdminTask.addNodeGroupMember ('[-interactive]')
  

• Use Jython list:

  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.

Target object The node group name to be created. This target object is required.

Parameters and return values

-shortName

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

-description

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createNodeGroup WBINodeGroup
  

• Use Jython string:

  AdminTask.createNodeGroup('WBINodeGroup')
  

• Use Jython list:

  AdminTask.createNodeGroup('WBINodeGroup')
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask createNodeGroup {-interactive}
  

• Use Jython string:

  AdminTask.createNodeGroup ('[-interactive]')
  

• Use Jython list:

  AdminTask.createNodeGroup (['-interactive'])
  

 

createNodeGroupProperty

The createNodeGroupProperty command creates custom properties for a node group.

Target object The name of the node group. This target object is required.

Parameters and return values

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

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask createNodeGroupProperty {-interactive}
  

• Use Jython string:

  AdminTask.createNodeGroupProperty ('[-interactive]')
  

• Use Jython list:

  AdminTask.createNodeGroupProperty (['-interactive'])
  

 

listNodeGroupProperties

The listNodeGroupProperties command displays all of the custom properties of a node group.

Target object The target object is name of the node group. This target object is required.

Parameters and return values

• Parameters: None

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listNodeGroupProperties WBINodeGroup
  

• Use Jython string:

  AdminTask.listNodeGroupProperties('WBINodeGroup')
  

• Use Jython list:

  AdminTask.listNodeGroupProperties('WBINodeGroup')
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listNodeGroupProperties {-interactive}
  

• Use Jython string:

  AdminTask.listNodeGroupProperties ('[-interactive]')
  

• Use Jython list:

  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.

Target object The target object is name of the node. This target object is optional.

Parameters and return values

• Parameters: None

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listNodeGroups  $AdminTask listNodeGroups nodeName
  

• Use Jython string:

  AdminTask.listNodeGroups   AdminTask.listNodeGroups('nodeName')
  

• Use Jython list:

  AdminTask.listNodeGroups   AdminTask.listNodeGroups('nodeName')
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listNodeGroups {-interactive}
  

• Use Jython string:

  AdminTask.listNodeGroups ('[-interactive]')
  

• Use Jython list:

  AdminTask.listNodeGroups (['-interactive'])
  

 

listNodes

The listNodes command displays all of the nodes in the cell.

Target object The target object is name of the node group. This target object is optional.

Parameters and return values

• Parameters: None

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listNodes
  

• Use Jython string:

  AdminTask.listNodes()
  

• Use Jython list:

  AdminTask.listNodes()
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listNodes {-interactive}
  

• Use Jython string:

  AdminTask.listNodes ('[-interactive]')
  

• Use Jython list:

  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.

Target object The target object is the node group name. This target object is required.

Parameters and return values

-shortName

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

-description

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

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask modifyNodeGroup {-interactive}
  

• Use Jython string:

  AdminTask.modifyNodeGroup ('[-interactive]')
  

• Use Jython list:

  AdminTask.modifyNodeGroup (['-interactive'])
  

 

modifyNodeGroupProperty

The modifyNodeGroupProperty command modifies custom properties for a node group

Target object The name of the node group. This target object is required.

Parameters and return values

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

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask modifyNodeGroupProperty {-interactive}
  

• Use Jython string:

  AdminTask.modifyNodeGroupProperty ('[-interactive]')
  

• Use Jython list:

  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.

Target object The name of the node group to be removed. This target object is required.

Parameters and return values

• Parameters: None

• Returns: The node group object ID.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroup WBINodeGroup
  

• Use Jython string:

  AdminTask.removeNodeGroup('WBINodeGroup')
  

• Use Jython list:

  AdminTask.removeNodeGroup('WBINodeGroup')
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroup {-interactive}
  

• Use Jython string:

  AdminTask.removeNodeGroup ('[-interactive]')
  

• Use Jython list:

  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.

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

Parameters and return values

-nodeName

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroupMember WBINodeGroup {-nodeName WBINode} 
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroupMember {-interactive}
  

• Use Jython string:

  AdminTask.removeNodeGroupMember ('[-interactive]')
  

• Use Jython list:

  AdminTask.removeNodeGroupMember (['-interactive'])
  

 

removeNodeGroupProperty

The removeNodeGroupProperty command removes custom properties of a node group.

Target object The name of the node group. This target object is required.

Parameters and return values

-name

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroupProperty WBINodeGroup {-name Channel}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask removeNodeGroupProperty {-interactive}
  

• Use Jython string:

  AdminTask.removeNodeGroupProperty ('[-interactive]')
  

• Use Jython list:

  AdminTask.removeNodeGroupProperty (['-interactive'])
  

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic