modifyWXSDefinition command
Use the modifyWXSDefinition command to modify the details of a WebSphere® eXtreme Scale (eXtreme Scale) definition, dependent on how the object that is being modified is identified.
The modifyWXSDefinition command is
run using the AdminTask object of the wsadmin scripting client.
- Locate the command that starts the wsadmin scripting client: this is found in the install_root\bin directory.
- Run the wsadmin command.
- If the server is not running, use the -conntype none option.
- If you are not connecting to the default profile, use the -profileName profile_name option.
Use the following command to list all the eXtreme Scale administrative
commands.
$AdminTask help WXSAdminCommands
Use
the following command to get detailed help on a particular command.$AdminTask help command_name
Prerequisites
Location
The modifyWXSDefinition command is run using the AdminTask object of the wsadmin scripting client. The wsadmin scripting client is located in the install_root\bin directory.
Syntax
$AdminTask modifyWXSDefinition {-paramName paramValue ...}
Required parameter
- -name definitionName
- The name of the WXS definition, as a string.
Optional parameters
If no optional parameters
are set, no modifications are made.
- -newName newdefName
- The new name of the eXtreme Scaledefinition,
as a string, if required. Note: This value must be unique.
- -description defDescription
- Brief description of the definition. This is optional, for your own reference.
- -catalogServiceEndpoints defcatalogServiceEndpoints
- The hostname (or IP address) and port of the eXtreme Scale Catalog
Server. Note: You can enter multiple endpoints, separated by commas.
- -gridName defgridName
- The ObjectGrid name defined in the ObjectGrid XML file.
- -securityEnabled securityEnabled
- Connected to server with secure connection, defined as a Boolean value (true or false).
- -credentialGenerator
- The method of security used to connect to the server. Select UserPassword or WSToken.Note: This parameter is required if the securityEnabled parameter value of the definition that you are modifying is set to true.
- -authAlias AUTHALIAS
- The alias to be used to authenticate with the eXtreme Scale server.Note: This parameter is required if the credentialGenerator parameter value is set to UserPassword.
Example
- Jython example:
AdminTask.modifyWXSDefinition('[-name MydefName -newName newdefName -description "my new description" -catalogServiceEndpoints localhost:9084 -gridName newgridName -securityEnabled true -credentialGenerator UserPassword -authAlias NEW_AUTH_ALIAS]')
- Jacl example:
$AdminTask modifyWXSDefinition {-name MydefName -newName newdefName -description "my new description" -catalogServiceEndpoints localhost:9084 -gridName newgridName -securityEnabled true -credentialGenerator UserPassword -authAlias NEW_AUTH_ALIAS}