Documentation Home
MySQL Enterprise Monitor 3.2 Manual
Related Documentation Download this Manual
PDF (US Ltr) - 3.7Mb
PDF (A4) - 3.7Mb
EPUB - 2.7Mb
HTML Download (TGZ) - 2.6Mb
HTML Download (Zip) - 2.7Mb


10.2 Agent Configuration Utility

The agent.sh/agent.bat script is used to configure an Agent. Its location:

Table 10.4 MEM Agent Configuration Tool Location (default)

Operating SystemPath
Microsoft WindowsC:\Program Files\MySQL\Enterprise\Agent\bin\agent.bat
Linux / Solaris/opt/mysql/enterprise/agent/bin/agent.sh
Mac OS X/Applications/mysql/enterprise/agent/bin/agent.sh

Use --help to view its options.

Agent Connection Utilities

Table 10.5 Agent Connection Utility

Name Description

--test-credentials

-T

Test MySQL connection credentials.

--test-privileges

Test admin user's privileges to manage other users.

--create-connection

-c

Create or Modify a MySQL connection.

--delete-connection

-d

Close and Delete a MySQL connection (must also specify --connection-id)

--show

-s

Show information about all MySQL connections on this agent

--auto-manage-extra-users

-m

Auto-create general / limited users (Actions: Create, Modify)

--host=<value>

-h <value>

Host for the MySQL instance (Actions: Create, Modify)

--port=<value>

-P <value>

Port for the MySQL instance (Actions: Create, Modify)

--socket=<value>

-S <value>

Socket for the MySQL instance (Actions: Create, Modify)

--limited-user=<value>

-l <value>

Limited level credentials (Actions: Create, Modify)

--general-user=<value>

-k <value>

General user credentials

--admin-user=<value>

-j <value>

Admin user credentials

--connection-id=<value>

-i <value>

Connection ID

--connection-group=<value>

-g <value>

MEM Group to use for created/modified connection

--force-plain-stdin,

-f

Force the use of STDIN for password inputs (password input is not masked - this option is useful only for very specific uses of these utilities, like calls from within automated scripts)

--disable-topology-discovery

Disable replication topology discovery. Use this parameter if you are not using replication, or if you want to discover the topology at a later time. Topology discovery can be time-consuming.

--mysql-identity-source=<value>

Source of identity for the MySQL instance for this connection, default or host_plus_datadir. default uses either the server_uuid variable, if present, or generates a new uuid. host_and_datadir uses a hash of the host identity and the path to the MySQL instance's data directory to create a unique identity.

--require-encryption

Require the use of TLS for the MySQL connection.

--allow-self-signed-certs

When using --require-encryption, allow self-signed TLS certificates.

--ca-file-path=<value>

When using --require-encryption, but using a private certificate authority, the path to the CA file.


The following example tests credentials for the root user on localhost:3306:

  agent.bat --test-credentials --admin-user=root --host=localhost --port=3306

The following example creates a connection using only the admin user for localhost:3306:

  agent.bat -c --admin-user=root --host=localhost --port=3306

The following example creates a connection, using only the admin user, to localhost:3306, and forces STDIN password:

  agent.bat -c --admin-user=root --host=localhost --port=3306 -f

The following example creates a connection, using only the admin user, to localhost:3306, and add to the groups Standard, Special, and Third:

  agent.bat -c --admin-user=root --host=localhost --port=3306 
            --connection-group=Standard --connection-group="Special Group" 
--connection-group="Third Group"

Agent Configuration Utilities

Table 10.6 Agent Configuration Utility

Name Description

--agent-user=<value>

-u <value>

Set the credentials that the Agent uses to connect to the Service Manager

--url=<value>

-U <value>

Set the URL for the Service Manager

--uuid=<value>

-I <value>

Set the Agent UUID

--agent-group=<value>

-G <value>

Set the MEM Group to use for all MySQL connections from this Agent

--force-plain-stdin

-f

Force the use of STDIN password inputs (password input is not masked - this option is useful only for very specific uses of these utilities, like calls from within automated scripts)

--run-collection-tests

-t

Discover, and attempt to collect OS related assets and dump them to STDOUT (for debugging)


The following example sets the user name and URL used by the agent to connect to the MySQL Enterprise Service Manager:

agent.sh --agent-user=agent --url=https://localhost:8443

User Comments
Sign Up Login You must be logged in to post a comment.