Utility command group of the AdminTask object

changeHostName

Use the changeHostName command to change the host name of a node.

Target object

None

Parameters and return values

-hostName

The new host name. (String, required)

-nodeName

The name of the node whose host name is changed. (String, required)

Optional parameters:

-systemName

The name of the z/OS system on which this node runs. This field is only required if a node is to be moved from one system to another, for example, form system SYSA to system SYSB. If you are not sure of the value that you should specify for this parameter, issue the IPLINFO command on your z/OS system, and use the name that displays in the Sysname= field as the value for this parameter.

Note: When you run the changeHostName command interactively, the systemName parameter appears, but is only to be used for a z/OS system. The systemName parameter represents the z/OS system name that is defined in the server.xml file as a value for property, was.ConfiguredSystemName. When the systemName parameter is selected, this property is changed.

-regenDefaultCert

A request to regenerate default certificates. The only valid value for this parameter is "true" if you want to regenerate default certificates. Any other value assumes to NOT regenerate default certificates. The string argument is processed as a Boolean. The Boolean returned represents the value true if the string argument is not null and is equal, ignoring case, to the string "true". The regenDefaultCert parameter operates like AdminTask.createChainedCertificate and has the following default values:

• -keyStoreName "NodeDefaultKeyStore"
• -keyStoreScope "(node):" + nodeName
• -certificateAlias" "default_" + hostName
• -certificateCommonName" nodeName
• -certificateOrganization" "IBM"
• -certificateOrganizationalUnit" nodeName
• -certificateCountry "US"

Note: For both AdminTask.createChainedCertificate and the regenDefaultCert parameters, if using the deployment manager node the -keyStoreName value changes to -keyStoreName "CellDefaultKeyStore", and the -keyStoreScope value to -keyStoreScope "(cell):" + cellname.

The switch is a convenience switch that makes assumptions about the default values of the certificate parameters. If the default values are not used, then AdminTask.createChainedCertificate or regenDefaultCert should be used instead.

Be aware of these functional details:

• keyStoreName and keyStoreScope are not valid with the regenDefaultCert parameter.
• When you run the changeHostName command, you cannot specify certificateCommonName (CN of new certification). To specify a new hostname as the CN, you need to use AdminTask.createChainedCertificate .

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask changeHostName {-hostName host_name -nodeName node_name 
  -systemName system_name}

• Using Jython string:

  AdminTask.changeHostName('-hostName host_name -nodeName node_name 
  -systemName system_name')

• Using Jython list:

  AdminTask.changeHostName(['-hostName', 'host_name', '-nodeName', 'node_name',
  '-systemName', 'system_name'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask changeHostName {-interactive}

• Using Jython string:

  AdminTask.changeHostName ('[-interactive]')

• Using Jython list:

  AdminTask.changeHostName (['-interactive'])

getDmgrProperties

Use the getDmgrProperties command to return the name of the deployment manager.

Target object

None

Parameters and return values

• Parameters: None
• Returns: The name of the deployment manager in a network deployment system. Returns an empty string if the system is a single server.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask getDmgrProperties {}

• Using Jython:

  AdminTask.getDmgrProperties()

isFederated

Use the isFederated command to check if the system is a single server or network deployment.

Target object

None

Parameters and return values

• Parameters: None
• Returns: Boolean. true if the system is a network deployment system. Otherwise, it returns false.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask isFederated {}

• Using Jython string:

  AdminTask.isFederated ()

renameCell

Target object

None

Parameters and return values

-newCellName

The new cell name. (String, required)

-dmgr_host

The name of the host or IP address of the deployment manager computer. (String, required if the command runs on a federated node)

-dmgr_port

The Java Management Extensions (JMX) connection port. (String, required if the command runs on a federated node. Default value "8879" is used if not specified)

-connType

The JMX connector type to use for connecting to the deployment manager. SOAP is the default JMX connector type for the command. Other valid types are JSR160RMI or Remote Method Invocation (RMI). (String, required if the command runs on a federated node. Default value "SOAP" is used if not specified)

-userName

The user name for authentication if security is enabled. (String, required if the command runs on a federated node and security is enabled)

-password

The password for authentication if security is enabled. (String, required if the command runs on a federated node and security is enabled)

Optional parameters:

-regenCerts

Determines whether to regenerate Secure Sockets Layer (SSL) certificates for all nodes of a cell. Only certificates for the default keystores are regenerated. This parameter does not apply for cells on z/OS operating systems. Keep in mind that regenerating certificates can cause clients accessing the server to reestablish trust with the server by getting the new certificate. The default value is false. Set to true to regenerate SSL certificates for nodes of a cell. (Boolean, optional)

-updateJaccContextID

Determines whether to update the security context ID of applications used by a Java Authorization Contract for Containers (JACC) provider. The default value is false. Set to true to update the security context ID. (Boolean, optional)

Batch mode example usage:

• Using Jython string:

  AdminTask.renameCell('-newCellName new_cell_name')

• Using Jython list:

  AdminTask.renameCell(['-newCellName', 'new_cell_name'])

Interactive mode example usage:

• Using Jython string:

  AdminTask.renameCell ('[-interactive]')

• Using Jython list:

  AdminTask.renameCell (['-interactive'])