NodeGroupCommands



Overview

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

The NodeGroupCommands includes the following commands:

 

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:

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

Examples

Batch mode example usage:

Interactive mode example usage:

 

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, we 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:

Interactive mode example usage:

 

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

Interactive mode example usage:

 

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

Examples

Batch mode example usage:

Interactive mode example usage:

 

listNodeGroups

The listNodeGroups command returns the list of node groups from the configuration repository. We 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

Examples

Batch mode example usage:

Interactive mode example usage:

 

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

Examples

Batch mode example usage:

Interactive mode example usage:

 

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:

Interactive mode example usage:

 

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

Interactive mode example usage:

 

removeNodeGroup

The removeNodeGroup command removes the configuration of a node group. We 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

Examples

Batch mode example usage:

Interactive mode example usage:

 

removeNodeGroupMember

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

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

Examples

Batch mode example usage:

Interactive mode example usage:

 

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

Examples

Batch mode example usage:

Interactive mode example usage:





 

Related tasks


Use AdminTask for scripted administration

 

Related


Commands for AdminTask