IBM Tivoli Monitoring, Version 6.3

tacmd exportWorkspaces

Description

This command exports one or more Tivoli Enterprise Portal Server workspaces to the file xml_file. This command can only be run from a Tivoli Enterprise Monitoring Server, Tivoli Enterprise Portal Server, or Tivoli Enterprise Portal Desktop Client installation.

Note: If you want to use the current tacmd tepsLogin values for username, password, and server hostname, do not enter any of these options for the exportWorkspaces command. If you specify values for some, but not all of these options, you are prompted to specify the username and password if they are missing.

Note: If you get an OutOfMemoryError when running this command, you can increase the java JVM memory size by using the TACMD_JVM_MAX_MEMORY variable. Valid values are 256 through to 2048, inclusive of that number is the number of megabytes to allocate for the max heap size.

CLI syntax

tacmd exportWorkspaces
        {-x|--xmlFile} XMLFILE
        {{-w|--workspace} WORKSPACE ... | {-i|--objectid} OBJECT_ID }
        [{-t|--type} TYPE ...]
        [{-r|--workspaceUser} USERID ...]
        [ {-e|--exclude} ]
        [ {-q|--queries} ]
        [{-f|--force}]
        [{-u|--username} TEPS_USER]
        [{-p|--password} TEPS_PASSWORD]
        [{-s|--server} TEPS_HOST[:PORT]]

tacmd exportWorkspaces
        {-h|--html}
        [{-l|--onehtmlfile} ]
        [{-w|--workspace} WORKSPACE ...]
        [ {-i|--objectid} OBJECT_ID ]
        [{-t|--type} TYPE ...]
        [{-r|--workspaceUser} USERID ...]
        [ {-e|--exclude} ]
        [{-f|--force}]
        [{-u|--username} TEPS_USER]
        [{-p|--password} TEPS_PASSWORD]
        [{-s|--server} TEPS_HOST[:PORT]]

where:

-x|--xmlFile: The name of the XML file accessible to the local file system where the workspace definition or definitions will be exported. This is the name of a file that can be created or overwritten. The file name can either be a relative or absolute file name.
-s|--server: Specifies a Tivoli Enterprise Portal Server to use. The host is a 32 or 64 bit IP address or hostname and port is an integer between 1 and 65536. If not specified, host defaults to localhost and port defaults to 15200.
-u|--username: The identifier of the user to authenticate on the remote Tivoli Enterprise Portal Server. The user must have both 'Workspace Administration Mode' and 'Workspace Author Mode' Workspace Administrator permissions enabled on the server to execute the listworkspaces command. The 'Workspace Administration Mode' permission is disabled by default for most users. The software prompts you for the username if you do not specify one.
-p|--password: The password of the user to authenticate on the remote Tivoli Enterprise Portal Server. Specify a valid string in the local locale. The software prompts you for the password if you do not specify one.
-w|--workspace: The name or names of the workspaces to display. Specify a string (any character except hyphen (-)) up to a maximum length of 72 characters. If not specified, all workspaces will be exported.
-i|--objectid: The object identifier of the workspaces to export. This switch cannot be used with the -w|--workspace or -e|--exclude options. You can retrieve the workspace object identifier by running the listworkspaces command with the -i|--objectid option.
-r|--workspaceUser: A Tivoli Enterprise Portal user ID that one or more Tivoli Enterprise Portal workspaces are associated with. Specify a string of letters (upper or lower case) or numbers up to a maximum length of 32 characters. If not specified, workspaces are exported for all users. To export only global workspaces, use this option without specifying any Tivoli® Enterprise Portal User IDs.
-t|--type: An IBM Tivoli Monitoring application type. If a 2-character type is entered, the letter ‘k’ will be prefixed automatically to form a 3-character type code. For example, _kib is the type for the Tivoli Enterprise Tivoli Monitor Workspaces. If not specified, all types are exported.
-e|--exclude: Exclude the specified workspace users, application types, and Tivoli Enterprise Portal user IDs from the export operation.
-q|--queries: Exports any queries that are used by the exported workspaces to the XML file.
-h|--html: Exports the workspaces and queries to HTML instead of XML.
-l|--onehtmlfile: Exports the queries and workspaces to a single HTML file.
-f|--force: Perform the export without prompting for confirmation first.

CLI example

This example exports all workspaces on the Tivoli Enterprise Portal Server myteps.ibm.com without any filtering arguments (such as workspace name, user ID, or application type).

Note: A large number (over 500) of workspaces can be displayed and exported.

   tacmd exportWorkspaces –s http://myteps.ibm.com:15200 –u imasample
                          –p mypassword-x all_workspaces.xml

This example exports all workspaces on the Tivoli Enterprise Portal Server myteps.ibm.com without any filtering arguments (such as workspace name, user ID, or application type). The -f option is used in this example to perform the export operation without prompting for confirmation.

Note: A large number (over 500) of workspaces are likely be exported.

   tacmd exportWorkspaces –s http://myteps.ibm.com –u imasample 
                          –p mypassword-x all_workspaces.xml -f

This example exports all workspaces belonging to the klz and knt application types on the Tivoli Enterprise Portal Server running on the local computer on port 15200 and filtered by application type.

   tacmd exportWorkspaces –u imasample –p mypassword–t klz knt 
                          -x klz_and_knt_workspaces.xml

This example is identical to the one above, except that the server credentials (username and password) were omitted at invocation time, and the user is interactively prompted to enter them.

   tacmd exportWorkspaces –s myteps.ibm.com –t klz knt

This example exports all workspaces belonging to (customized for) the SYSADMIN user on the Tivoli Enterprise Portal Server myteps.ibm.com and filtered by username.

Note: In this example no global workspaces are exported.

   tacmd exportWorkspaces –s myteps.ibm.com –u imasample –p mypassword–r SYSADMIN

This example exports only workspaces matching the names Historical Summarized Availability Daily or Historical Summarized Availability Weekly on the Tivoli Enterprise Portal Server myteps.ibm.com and filtered by workspace name.

   tacmd exportWorkspaces –s myteps.ibm.com –u imasample –p mypassword 
         –w “Historical Summarized Availability Daily” 
            “Historical Summarized Availability Weekly”

This example exports only workspaces belonging to the klz and knt application types, workspace names matching the names Historical Summarized Availability Daily or Historical Summarized Availability Weekly on the Tivoli Enterprise Portal Server myteps.ibm.com, and filtered by both workspace name and application type.

   tacmd exportWorkspaces –s myteps.ibm.com –u imasample –p mypassword–t klz kux 
		–w “Historical Summarized Availability Daily” 
         “Historical Summarized Availability Weekly"

Return values

See Return codes.

Related commands

tacmd listworkspaces

tacmd importWorkspaces

Return to Table 1.

Feedback