Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)

ConfigArchiveOperations command group using wsadmin.sh

Use the Jython or Jacl scripting languages to configure servers in the environment. The commands and parameters in the ConfigArchiveOperations group can be used to export or import server configurations and entire cell configurations.

The ConfigArchiveOperations command group includes the following commands:

• exportProxyProfile

• exportProxyServer

• exportServer

• exportWasprofile

• importProxyProfile

• importProxyServer

• importServer

• importWasprofile

exportProxyProfile

Use the exportProxyProfile command to export the entire cell configuration of a secure proxy server to a configuration archive. The exportProxyProfile command does not work between the distributed and z/OS operating systems.

Target object None

Required parameters

-archive

Fully qualified file path of the exported configuration archive. (String, required)

Return value

The command does not return output.

Batch mode example usage

• (Windows) Using Jython string:

  AdminTask.exportProxyProfile('[-archive "c:/myCell.car"]')
  

• (AIX) (Solaris) Using Jython string:

  AdminTask.exportProxyProfile('-archive c:/myCell.car')
  

• (Windows) Using Jython list:

  AdminTask.exportProxyProfile(['-archive', 'c:/myCell.car'])
  

• (AIX) (Solaris) Using Jython list:

  AdminTask.exportProxyProfile(['-archive', 'c:/myCell.car'])
  

Interactive example...

### Jython

AdminTask.exportProxyProfile('-interactive')

exportProxyServer

Use the exportProxyServer command to export the secure proxy server configuration to a node that is defined in the configuration archive. The command exports the metadata file of the node where the server resides. We can use this information later when you import the configuration archive to verify that the target node is compatible to the node from which you are exporting the server.

The exportProxyServer command virtualizes the server configuration and exports a server to a configuration archive. This process breaks any existing associations between the server configurations in the configuration archive and the configurations in the system.

Target object None

Required parameters

-archive

Fully qualified path of the exported configuration archive. (String, required)

-serverName

Secure proxy server name. (String, required)

Optional parameters

-nodeName

Node name of the secure proxy server. This parameter is only required if the secure proxy server name is not unique across the cell. (String, optional)

Return value

The command does not return output.

Examples

Batch mode example usage:

### Jython string

AdminTask.exportProxyServer('[-archive c:/myProxyServer.car -nodeName node1
 -serverName server1]')

• Jython list:

  AdminTask.exportProxyServer(['-archive', 'c:/myProxyServer.car', '-nodeName',
   'node1', '-serverName', 'server1'])
  

• (AIX) (Solaris)

  Use Jython string:

  AdminTask.exportProxyServer('[-archive /myProxyServer.car -nodeName node1
   -serverName server1]')
  

• (AIX) (Solaris)

  Use Jython list:

  AdminTask.exportProxyServer(['-archive', '/myProxyServer.car', '-nodeName', 'node1',
   '-serverName', 'server1'])
  

Interactive example...

### Jython

AdminTask.exportServer ('-interactive')

exportServer

Use the exportServer command to export the server configuration to a node that is defined in the configuration archive. Use the exportProxyServer command to export a proxy server configuration.

The exportServer command virtualizes the server configuration and exports a server to a configuration archive. This process breaks any existing associations between the server configurations in the configuration archive and the configurations in the system. This process also removes applications from the server that you specify, breaks the relationship between the server that you specify and the core group of the server, cluster, or service integration bus member.

The exportServer command exports the metadata file of the node where the server resides. You can use this information later when you import the configuration archive to verify that the target node is compatible to the node from which you are exporting the server.

Target object None

Parameters and return values

-archive

Fully qualified path of the exported configuration archive. (String, required)

-nodeName

Node name of the server. This parameter is only required when the server name is not unique across the cell. (String, optional)

-serverName

Server name. (String, required)

Examples

Batch mode example usage:

### Jacl

$AdminTask exportServer {-archive c:/myServer.car -nodeName node1 -serverName
 server1}

### Jython string

AdminTask.exportServer('[-archive c:/myServer.car -nodeName node1 -serverName
 server1]')

• Jython list:

  AdminTask.exportServer(['-archive', 'c:/myServer.car', '-nodeName', 'node1',
   '-serverName', 'server1'])
  

Interactive example...

### Jacl

$AdminTask exportServer {-interactive}

### Jython string

AdminTask.exportServer ('[-interactive]')

• Jython list:

  AdminTask.exportServer (['-interactive'])
  

exportWasprofile

Use the exportWasprofile command to export the entire cell configuration to a configuration archive. The exportWasprofile command does not work between the distributed and z/OS platforms.

Restriction: Only a base server configuration with a single node is supported for the exportWasprofile command. Use the exportProxyProfile command to export a secure proxy server configuration.

Target object None

Parameters and return values

-archive

Fully qualified file path of the exported configuration archive. (String, required)

Examples Batch mode example usage:

### Jacl

$AdminTask exportWasprofile {-archive c:/myCell.car}

### Jython string

AdminTask.exportWasprofile('[-archive c:/myCell.car]')

• Jython list:

  AdminTask.exportWasprofile(['-archive', 'c:/myCell.car'])
  

Interactive example...

### Jacl

$AdminTask exportWasprofile {-interactive}

### Jython string

AdminTask.exportWasprofile ('[-interactive]')

• Jython list:

  AdminTask.exportWasprofile (['-interactive'])
  

importProxyProfile

Use the importProxyProfile command to import a cell configuration in the configuration archive to the system. Only a base single server configuration is supported for this command. The importProxyProfile command does not work between the distributed and z/OS platforms.

Target object None

Required parameters

-archive

Fully qualified file path of the exported configuration archive. (String, required)

Optional parameters

-deleteExistingServers

Whether to replace the existing secure proxy servers in the profile with the servers in the imported proxy profile. Specify true to overwrite the existing servers. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

• (Windows) Using Jython string:

  AdminTask.importProxyProfile('-archive c:/myCell.car -deleteExistingServers true')
  

• (AIX) (Solaris) Using Jython string:

  AdminTask.importProxyProfile('-archive /myCell.car -deleteExistingServers
   true')
  

• (Windows) Using Jython list:

  AdminTask.importProxyProfile('-archive', 'c:/myCell.car', '-deleteExistingServers',
   'true')
  

• (AIX) (Solaris) Using Jython list:

  AdminTask.importProxyProfile('-archive', '/myCell.car', '-deleteExistingServers', 'true')
  

Interactive example...

### Jython

AdminTask.importProxyProfile('-interactive')

importProxyServer

Use the importProxyServer command to import a secure proxy server that resides in a configuration archive to the system. This command imports all the server scope configurations defined in the configuration archive to system configuration.

Target object None

Required parameters

-archive

Fully qualified path of the configuration archive to import. (String, required)

Optional parameters

-nodeInArchive

Node name of the server defined in the configuration archive. Specify a value for this parameter if multiple nodes exist in the configuration archive. (String, optional)

-serverInArchive

Name of the secure proxy server defined in the configuration archive. Specify a value for this parameter if multiple secure proxy servers exist in the archive. (String, optional)

-deleteExistingServer

Whether to delete and replace an existing server if it has the same name as the server to import. Set the value of this command to true to overwrite existing servers with the same name. (String, optional)

-nodeName

Name of the node to which the secure proxy server is imported. This parameter is only required if the secure proxy server name is not unique across the cell. (String, optional)

-serverName

Secure proxy server name. If the server name that you specify matches an existing server name under the node, an exception is created. (String, optional)

-coreGroup

Specifies the core group name to which the secure proxy server belongs. (String, optional)

Return value

The command does not return output.

Examples

Batch mode example usage:

### Jython string

AdminTask.importProxyServer('[-archive c:/myProxyServer.car -nodeName node1
 -serverInArchive server1 -deleteExistingServer true]')

• Jython list:

  AdminTask.importProxyServer(['-archive', 'c:/myProxyServer.car', '-nodeName',
   'node1', '-serverInArchive', 'server1', '-deleteExistingServer', 'true'])
  

• (AIX) (Solaris)

  Use Jython string:

  AdminTask.importProxyServer('[-archive /myProxyServer.car -nodeName node1
   -serverInArchive server1 -deleteExistingServer true]')
  

• (AIX) (Solaris)

  Use Jython list:

  AdminTask.importProxyServer(['-archive', '/myProxyServer.car', '-nodeName', 'node1',
   '-serverInArchive', 'server1', 'server1', '-deleteExistingServer', 'true'])
  

Interactive example...

### Jython

AdminTask.importProxyServer('-interactive')

importServer

Use the importServer command to import a server that resides in a configuration archive to the system. This command imports all the server scope configurations defined in the configuration archive to system configuration. Use the importProxyServer command to import a secure proxy server configuration.

Target object None

Parameters and return values

-archive

Fully qualified path of the configuration archive. (String, required)

-nodeInArchive

Node name of the server defined in the configuration archive. (String, optional if there is only one node defined in the configuration archive, required if there are multiple nodes defined in the configuration archive)

-serverInArchive

Name of the server defined in the configuration archive. (String, optional if there is only one server defined on the specified nodeInConfiguration archive, required if there are multiple servers defined under the specified nodeInConfiguration archive)

-nodeName

Node name where the server is imported. (String, optional if there is only one node)

-serverName

Server name where the server is imported. If the server name that you specify matches an existing server name under the node, an exception is created. (String, optional, default: serverInArchive)

-coreGroup

Specifies the core group name to which the server should belong. (String, optional)

Examples

Batch mode example usage:

### Jacl

$AdminTask importServer {-archive c:/myServer.car -nodeInArchive node1
 -serverInArchive server1}

### Jython string

AdminTask.importServer('[-archive c:/myServer.car -nodeInArchive node1
 -serverInArchive server1]')

• Jython list:

  AdminTask.importServer(['-archive', 'c:/myServer.car', '-nodeInArchive', 'node1',
   '-serverInArchive', 'server1'])
  

Interactive example...

### Jacl

$AdminTask importServer {-interactive}

### Jython string

AdminTask.importServer ('[-interactive]')

• Jython list:

  AdminTask.importServer (['-interactive'])
  

importWasprofile

Use the importWasprofile command to import a cell configuration in the configuration archive to the system. Only a base server configuration with single node is supported for this command. Use the importProxyProfile command to import a secure proxy server profile.

The importWasprofile command does not work between distributed and z/OS operating systems.

Target object None

Parameters and return values

-archive

Fully qualified file path of the configuration archive. (String, required)

-deleteExistingServers

When set to true, specifies to remove existing servers from the target profile and import the configuration archive onto the target profile. (Boolean, optional)

Default value is false, which specifies to not replace servers.

Examples

Batch example...

### Jacl

$AdminTask importWasprofile {-archive c:/myCell.car}

New feature:

$AdminTask importWasprofile { -archive profile.car -deleteExistingServers true}

### Jython string

AdminTask.importWasprofile('[-archive c:/myCell.car]')

New feature:

AdminTask.importWasprofile('[-archive profile.car -deleteExistingServers true]')

• Jython list:

  AdminTask.importWasprofile(['-archive', 'c:/myCell.car'])
  

  New feature:

  AdminTask.importWasprofile(['-archive', 'profile.car', '-deleteExistingServers', true])
  

Interactive example...

### Jacl

$AdminTask importWasprofile {-interactive}

### Jython string

AdminTask.importWasprofile ('[-interactive]')

• Jython list:

  AdminTask.importWasprofile (['-interactive'])
  

Use the wsadmin scripting AdminTask object for scripted administration

Related

Commands using wsadmin.sh
Use wsadmin scripting with Jython

+

Search Tips   |   Advanced Search