Monitoring Agent Options

Syntax


Option	Description
`[-help\|-h]`	Shows the help.
`[-version]`	Displays the version of the monitoring agent.
`[-outputFile\|-o] PATH [MAX_SIZE]`	Sets the path for the output file used to save monitoring information. Use this option while starting the Monitoring Agent (when the Monitoring Agent is not installed as a service, or running the Monitoring Agent from the 3DEXPERIENCE platform services install path)
`[-keystore\|-ks] PATH`	Sets the path to the keystore file created. `PATH` is the file path including the file name.
`[-setVar] VAR_NAME VAR_VALUE`	Sets the variable that can be used while setting probes using `VAR_NAME`
`[-rmVar] VAR_NAME`	Removes variable which was set by `-setVar`
`[–setProbe] PROBE_NAME PROBE_SUBJECT [<parameter_name>=<value>]* [condition:<expr>] [period:<period value>] [active:[true\|false]]`	Sets up the probe run by the Monitoring Agent. where: `PROBE_NAME` is the name of the probe `PROBE_SUBJECT` is the name of the probe's subject. `<parameter_name>` is the name of one of the probe's parameters; it must be followed by an equal sign and the value `<value>` that will be assigned to this parameter. `<value>` is a string which may contain a reference to a variable, using the `{VAR_NAME}` syntax where VAR_NAME is set by the -setVar command. Or, you can can directly use the parameter value. `<expr>` is conditional expression; currently only `os=<value>` and `VMHaMode=<value>` conditions are available. `<period value>` is the period at which the monitoring agent calls the probe; it must have the following form: `<duration>`s for a period expressed in seconds `<duration>`m for a period expressed in minutes `<duration>`h for a period expressed in hours where `<duration>` is a positive integer value.
`[–rmProbe] PROBE_NAME PROBE_SUBJECT`	Removes probe set by `-setProbe`
`[-cfg] configuration_file_path`	The probes and variable information (`–setProbe` and `–setVar`) passed via command line is saved in the default configuration file: Windows:MonitoringAgentAndProbesInstallPath>\win_b64\resources\monitoring\MonitoringAgent.cfg Linux: <MonitoringAgentAndProbesInstallPath>/linux_a64/resources/monitoring/MonitoringAgent.cfg You can save the probe and variable information in another configuration file using the following option. Monitoring agent installed as a service: update this newly defined configuration file full path (`cfg=C:\\..\\MonitoringAgent.cfg`) in: Windows: <MonitoringAgentAndProbesInstallPath>\conf\MASvcWinPrem.properties Linux: <MonitoringAgentAndProbesInstallPath>/conf/MASvcLinPrem.properties Monitoring agent installed without a service: use this user defined configuration file full path when run the monitoring agent. Note: If you do not set any preferred configuration file, you do not need to use this option: the monitoring agent will use the default file.
`[-setkey\|-sk] SERVICE [LOGIN] [PASSWORD]`	Sets a key in the keystore file. `SERVICE` is the name of the service associated with the key, for example the 3DPassport service URL `LOGIN` is the username associated with the key `PASSWORD` is the password associated with the key.
`[-delkey\|-dk] SERVICE`	Deletes a key in the keystore file. `SERVICE` is the name of the service associated with the key, for example the 3DPassport service URL
`[-showCfg]`	Display the configuration of the monitoring agent (all the probes and variables set by the above commands)
`[-showEvalCfg]`	Display the configuration with valuated variables

Starting the agent with the -h or -help option provides access to the arguments for monitoring each 3DEXPERIENCE service.