Using agentpref

Any space characters in the extension name might need to be enclosed in quotation marks depending on the shell being used to issue the command.

Parameters

Use to...

--host

Hostname of the agent machine where the TMTM Extensible Agent (qpea) is running. Required unless specified in an eaapi.ini file or agent on the same machine.

--port

Optional. Port number for the TMTM Extensible Agent. Defaults to 2612 or as specified in an eaapi.ini file.

--set-agent (pref_name value)*

Optional. You can have one or more set command, each with one or more preferences.

--set-agent-dynamic (pref_name)*

Optional. Set one or more dynamic preferences for the TMTM Extensible Agent. More than one --set-agent-dynamic can be specified.

--set-agent RTServer_Port <port number>

Enables you to modify the port number.

<port number> is the port number of the RTServer in your installation.

-set extension_name [-pref_path type_path name_path] (pref_name value)*

Optional. You can have one or more set command, each with one or more preferences.

-–pref_path defaults to Default\Default if not specified.

type_path has the format of type_path1!type_path2!...

name_path has the format of name_path1!name_path2!...

-set-dynamic extension_name [-pref_path type_path name_path] (pref_name value)*

Optional. Use with extreme care because names are not validated. Set one or more preferences for specified extension where the extension is new and not known to the utility or where the preference name is dynamic or unique to the environment rather than a well-known value listed by --list-preferences. More than one --set_dynamic can be specified.

-–pref_path defaults to Default\Default if not specified.

type_path has the format of type_path1!type_path2!...

name_path has the format of name_path1!name_path2!...

--get-agent

Optional. Displays currently set preferences for the TMTM Extensible Agent.

--get extension_name

Optional. Displays currently set preferences for the named extension.

--notify extension_name

Optional. Notifies specified extension to get preferences.

--list-preferences

Optional. List the preferences that can be set.

--version

Optional. Print the version information.

--export filename

Optional. Export the agent and extension preferences to file name.

--import filename

Optional. Import the agent and extension preferences from file name.

--remove-agent (pref_name)*

Optional. Remove one or more preference for the TMTM Extensible Agent. You can have one or more --remove-agent command, each with one or more preferences.

--remove-agent-dynamic (pref_name)*

Optional. Remove one or more dynamic preferences for the TMTM Extensible Agent. More than one --remove-agent-dynamic can be specified.

-remove extension_name [-pref_path type_path name_path] (pref_name)*

Optional. Remove one or more preferences for the specified extension. You can have one or more remove commands, each with one or more preferences.

-–pref_path defaults to Default\Default if not specified.

type_path has the format of type_path1!type_path2!...

name_path has the format of name_path1!name_path2!...

-remove-dynamic extension_name [-pref_path type_path name_path] (pref_name)*

Optional. Use with extreme care because names are not validated. Remove one or more preferences for specified extension where the extension is new and not known to the utility or where the preference name is dynamic or unique to the environment rather than a well-known value listed by --list-preferences. You can have one or more remove-dynamic commands, each with one or more preferences.

-–pref_path defaults to Default\Default if not specified.

type_path has the format of type_path1!type_path2!...

name_path has the format of name_path1!name_path2!...

--set-remote-qmgr-csv filename

Add remote connection definition from a CSV file.

Was this page helpful? Yes No Submitting... Thank you

Comments