delete option for the imam command

Use the delete option to delete import areas. You can use the delete option when you use the imam command with the --action parameter.

Purpose

You can use the delete option to delete import areas and remove their contents from the staging area of InfoSphere® Metadata Asset Manager. Assets that were shared to the metadata repository from the import area are not deleted. You can delete one import area per command.

If you have the Common Metadata Administrator role, you can delete import areas that are created by all users. If you have the Common Metadata Importer role, you can delete only import areas that you created. If an import areas has an import that is shared to the repository, then Common Metadata Importers and Common Metadata Administrators can delete the import areas only if the setting Allow users to delete import areas in which imports were shared to the repository is selected on the Administration tab in InfoSphere Metadata Asset Manager.

Syntax

imam --action delete --type area --name asset_name
[--username username] [--password password][--authfile authfile_path]  
[--server server_name] [--port port_number] [--help] [--silent] [--log]

Parameters

When you specify the long name of a parameter, you must type two dashes (--) before the parameter. For example, --action. When you specify the short name of a parameter, type only one dash (-). For example, -a.

Commands that use the delete option can use the following parameters.

Table 1. Parameters that can be used with the delete option
Parameter name Description
--action or -a

Required.

Use the delete option.

--type or -t

Required.

Specify area as the value.

--name or -n

Required.

Name of the import area to delete. If the name contains blank spaces, you must put quotation marks around the blank spaces. If the name contains quotation marks, you must enter a backslash character (\) before each of the quotation marks. For more information, see Escaping characters.

--authfile or -af

Optional.

Path to a file that contains the encrypted or non-encrypted credentials for logging on to InfoSphere Information Server. If you use the --authfile parameter, you do not need to specify --username or --password on the command line. If you specify both the --authfile parameter and the explicit user name and password parameters, the explicit parameters take precedence over what is specified in the file.

For more information, see the topic Encrypt command and its subtopics.

--username or -u

Optional.

User name that is required for logging into InfoSphere Information Server. The user must have the role of Common Metadata Administrator or Common Metadata Importer. You can use the --authfile parameter instead of specifying the --username and --password parameters. If you enter a user name without entering a password you are prompted for a password when you run the command.

--password or -w

Optional.

Password for the specified user name to log into InfoSphere Information Server. You can use the --authfile parameter instead of specifying the --username and --password parameters.

By default, passwords are saved. This default setting is controlled on the Import Settings page of the Administration tab of InfoSphere Metadata Asset Manager.

--server or -s

Optional.

Name of the services tier computer. If you specify a server, then you must specify a port.

--port or -p

Optional.

Port number to use on the services tier computer. The default HTTPS port is 9443. If you specify a port, you must specify a server.

--silent or -sl

Optional.

Suppresses prompts for credentials and SSL certificates. Use this parameter when you run scheduled or unattended sessions. When a prompt is suppressed, the action fails.

To prevent such failures, provide credentials on the command line or in a credentials file, if necessary, and Run the UpdateSignerCerts command to retrieve the certificate before you schedule a command-line session. .

--help or -h

Optional.

If you use --help with other options, the other options are ignored. Prints the list of actions and parameters. The help command is automatically issued when you issue a command that contains a syntax error, such as a typographical error, an improperly cased parameter or argument, or when the command is missing a required parameter.

--log or -lg

Optional.

Prints runtime log messages to the console while you run the command line. You can use the log to debug issues that arise when you use InfoSphere Metadata Asset Manager. The log includes the details of the HTTPS call that is made to the server, and stack trace information for any exceptions that are thrown.

delete example

The following command deletes the import area area51.
imam --username isadmin --password isadmin –-action delete –-type area –-name area51