UPDATE command
After you import an application or service provider, some metadata information might not match the metadata information in the environment into which it is imported. You use the UPDATE command to update this metadata information directly in the repository to match the metadata information in the new environment.
Purpose
The UPDATE command updates metadata information from runtime applications and IBM® InfoSphere® Information Server connections. The scope of the metadata update operation is determined by looking for an agent host name, application name, or connection name. For every metadata UPDATE command that you enter, you must specify one of the following keys: -agenthost, -application, or -cname.
Syntax
Update metadata information for a specified application:
ISDAdmin -action update [-user <user name>
[-password <user password>] | -authfile <file name>]
-a <application name> -s <service name> -o <operation name>
-key <key for the metadata attribute to be updated>
-subkey <job parameter argument you want to modify>
-oldvalue <old value of the attribute you want to modify>
-newvalue <new value for the attribute that you are modifying>
-dsproject <project name> -dsjob <job name> -providerUser <service provider> Update metadata information for a specified agent server host:
ISDAdmin -action update [-user <user name>
[-password <user password>] | -authfile <file name>]
-agentHost <agent host name> -providerType <DS, Db2. ORA, or Db2.F>
-providerHost <service provider server host name>
-key <key for the metadata attribute to be updated>
-subkey <job parameter argument you want to modify>
-oldvalue <old value of the attribute you want to modify>
-newvalue <new value for the attribute that you are modifying>
-dsproject <project name> -dsjob <job name> -providerUser <service provider> Update metadata information for a specified connection:
ISDAdmin -action update [-user <user name>
[-password <user password>] | -authfile <file name>]
-cname <connection name> -key <key for the metadata attribute to be updated>
-oldvalue <old value of the attribute you want to modify>
-newvalue <new value for the attribute that you are modifying> Application metadata parameters
The UPDATE command uses the following parameters. There are three paths (application, agent host, or connection name) for using this command. Each path has different mandatory and optional options. For every metadata UPDATE command that you enter, you need to specify one of the following options: -agenthost, -application, or -cname.
| Parameter name (short name) | Description |
|---|---|
| -action (-act) | Required Type update. |
| -authfile (-af) | Optional The authorization file that includes the user and password credentials to use in lieu of providing the credentials at the command prompt or with the -user and -password parameters. |
| -user (-ur) | Optional Your IBM InfoSphere Information Server user ID. If not provided and the -authfile parameter is not used, you will be prompted for a user ID. |
| -password (-pw) | Optional Your IBM InfoSphere Information Server password. If not provided and the -authfile parameter is not used, you will be prompted for a password. |
| -application (-a) | Optional Use the -a parameter if you want to apply the metadata update within the scope of a particular application. Enter the name of the application for which you want to update metadata. You can use the application name to qualify or restrict the operation and provider metadata update. |
| -agentHost (-ahost) | Optional Use the -ahost parameter if you want to apply the metadata update within the scope of a specific agent. Note: The agent host can also be used as a key when its
value needs to be updated.
Enter the host name of the agent server. |
| -cname (-c) | Optional Use the -c parameter if you want to apply the metadata update within the scope of a InfoSphere Information Server connection. Enter the name that is assigned to the connection between the service provider and InfoSphere Information Server. |
| -key (-k) | Required Enter the key to be updated. For example, to update the DataStage® password, enter DS_PASSWORD. If the key is linked to other options, enter the parameters for those options after the key. More information on the supported keys and their dependencies on other options is provided in the tables that follow later in this topic. |
| -subkey (-sk) | Optional Use -subkey to update job parameter settings. Enter the argument for the setting you want to modify. |
| -service (-s) | Optional Enter the name of the service in the application for which you want to update metadata. This parameter is part of the -application path. |
| -operation (-o) | Optional Enter the name of the operation in the service for which you want to update metadata. This parameter is part of the -application and -service path. |
| -oldvalue (-ov) | Optional Use -oldvalue when you use any of the following key values to update a metadata attribute:
Note: This parameter is required when you need to specify
a particular value for a key that has more than one possible value
attached to it. This parameter is optional in all other cases in which
there is only one possible value for the key that you are updating.
For that reason, it is unnecessary to specify a value in those scenarios.
Enter the exact existing value of the item to be updated. |
| -newvalue (-nv) | Required Enter the new value to assign to the metadata attribute that you are updating. When the value for the -key parameter is a password (such as DS_PASSWORD, Db2.PASSWORD, ORA_PASSWORD, Db2.F_PASSWORD, or PASSWORD), the value for this -newvalue parameter can be in the form of a string that has been encrypted with the encrypt command. |
| -providerType (-prType) | Optional You must use -providerType when
you are updating any of the following service providers:
|
| -providerUser (-pUr) | Optional You must use -providerUser when you update a service provider password. Enter the user name of the service provider. |
| -dsproject (-dsp) | Optional This parameter can be used when the job name is being updated. Enter the name of the project for which you want to update metadata. Note: You can also
use this parameter to identify a specific project that is attached
to an operation when you are updating the parameters of that job.
|
| -dsjob (-dsj) | Optional Enter the name of the job for which you want to update metadata. Note: You can
use this parameter to identify a specific DataStage job that is attached to an operation
when you are updating the parameters of that job.
|
| -providerHost (-pHost) | Optional You must use -pHost when you update the Db2 database name, Db2 port, Db2 user ID, or Db2 password. Enter the name of the service provider host server. |
| -verbose (-v) | Optional Display detailed runtime output (not runtime logging messages). |
| -results (-res) | Optional Print all runtime output to the specified file. |
| -log (-l) | Optional Print all runtime logging messages to the specified file. Use this option with -loglevel. |
| -logerror (-error) | Optional Print all ERROR and FATAL runtime logging messages to the specified file. |
| -loginfo (-info) | Optional Print all INFO, WARN, DEBUG, and TRACE runtime logging messages to the specified file. |
| -loglevel (-level) | Optional Specify one of the following logging levels to print: ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. |
| -help (-?) | Optional Displays help for this command. |
Operation keys
The values of the following keys can be changed to update operation metadata. These keys do not have dependencies with other parameters.
| Key name | Description |
|---|---|
| MAX_QUEUESIZE | Maximum number of service requests that can be in the operation queue at the same time. |
| MAX_QUEUEWAIT | Maximum length of time that you want a service request to wait in an operation queue. |
| MAX_RETRIES | Maximum number of tries that a service request makes to the server if the request is not received the first time. This setting applies only if there is more than one ASB Agent to send a request to. |
| LOAD_BALANCER | Method used to send service requests to the server when multiple service providers are attached to the same operation. |
Common provider keys
The values of the following keys can be changed to update common provider metadata. These keys do not have dependencies with other parameters.
| Key name | Description |
|---|---|
| ACTIVATION_DELAY | Length of time, in milliseconds, that the designated number of service requests (set in ACTIVATION_THRESHOLD) must be in the operation queue before the service provider starts another job or server connection. |
| ACTIVATION_THRESHOLD | Number of service requests that must be in the operation queue for a designated length of time (set in ACTIVATION_DELAY) before the service provider starts another job or server connection. Applies to the number of service requests in the operation queue only; does not include the number of service requests in the pipeline. |
| AGENT_HOST | Host name of the agent server that communicates with the service provider. |
| AGENT_PORT | Port number on the agent server that is used to access the service provider. |
| MAX_ACTIVE | Maximum number of job instances or server connections that can be active at the same time. The service provider cannot start a new job or connection after it reaches the maximum number. |
| MAX_IDLE | Maximum length of time, in seconds, that a job instance or connection can be idle before it must be stopped. You can set a maximum idle time if there is a known limit to the length of time the job or connection can be idle. |
| MAX_RUNTIME | Maximum length of time that a job uses to process service requests. The job processes requests that are in the pipeline when the maximum run time is reached, but the job is not available for subsequent requests. |
| MIN_ACTIVE | Minimum number of job instances or server connections that can be active at the same time. The minimum number means that at least one job or server connection is always running. |
| MIN_IDLE | Length of time, in seconds, that a job instance or connection can be idle before it must be stopped. |
| REQUEST_LIMIT | Maximum number of service requests that the job instance processes at the same time. Only some service providers, such as InfoSphere DataStage, have this capability. |
| STUCK_TIMEOUT | Length of time, in seconds, over which the service provider processes an operation before returning an error. |
IBM InfoSphere DataStage provider keys
The values of the following keys can be changed to update metadata for InfoSphere DataStage providers. Some of these keys must be used with the options on which they are dependent.
| Key name | Description |
|---|---|
| DS_PROJECT_NAME | Name of the new IBM InfoSphere DataStage project for which to update metadata. |
| DS_JOBNAME | Name of the new InfoSphere DataStage job for which to update metadata. |
| DS_USERID | Your InfoSphere Information Server engine user ID. |
| DS_PASSWORD | Your InfoSphere Information Server engine
password. Use with -providerUser, your login user id. |
| DS_HOST | Host name or server name of your InfoSphere Information Server engine. |
| DS_PORT | Number of the port used to access your InfoSphere Information Server engine. |
| JOB_PARAMETER | Name of the job parameter for which to update metadata. |
IBM Db2 provider keys
| Key name | Description |
|---|---|
| DB2_USERID | Your Db2 server user ID. Use with -providerHost, the Db2 server name. |
| DB2_PASSWORD | Your Db2 server
password. Use with -providerUser, your Db2 user ID. |
| DB2_HOST | Host name or server name of the Db2 server. |
| DB2_PORT | Number of the port used to access the Db2 server. |
| DB2_DATABASE | Name of the Db2 database. |
Oracle database provider keys
The values of the following keys can be changed to update metadata for Oracle providers.
| Key name | Description |
|---|---|
| ORA_USERID | Your Oracle database server user ID. |
| ORA_PASSWORD | Your Oracle database server password. Use with -providerUser, your Oracle user ID. |
| ORA_HOST | Host name or server name of the Oracle server. |
| ORA_PORT | Port number that is used to access the Oracle server. |
| ORA_DATABASE | Name of the Oracle database. |
IBM InfoSphere Classic Federation Server for z/OS server metadata keys
The values of the following keys can be changed to update metadata for InfoSphere Classic Federation Server for z/OS®.
| Key name | Description |
|---|---|
| DB2CF_USERID | Your InfoSphere Classic Federation Server for z/OS user ID. |
| DB2CF_PASSWORD | Your InfoSphere Classic Federation Server for z/OS password. Use with -providerUser, your Classic Federation user ID. |
| DB2CF_HOST | Host name or server name of the InfoSphere Classic Federation Server for z/OS. |
| DB2CF_PORT | Port number that is used to access the InfoSphere Classic Federation Server for z/OS server. |
| DB2CF_DATABASE | Name of the database for the InfoSphere Classic Federation Server for z/OS. |
Connection metadata keys
The values of the following keys can be changed to update metadata for InfoSphere Information Server connections.
| Key name | Description |
|---|---|
| USER | Your DataStage or Db2 server user ID. |
| PASSWORD | Your DataStage or Db2 server password. Use with -providerUser, your provider user ID. |
| HOSTNAME | For Db2 connections
only. Host name or server name of the Db2 server. |
| PORT | Port number that is used to access the DataStage or Db2 server. |
| DBNAME | For Db2 connections
only. Name of the Db2 database. |