From 5cf5d59c2e8f1cffd20d6d64e68045d8d68f3c56 Mon Sep 17 00:00:00 2001 From: Simon Notley <43099400+sonotley@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:36:42 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pem/9/registering_agent.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pem/9/registering_agent.mdx b/product_docs/docs/pem/9/registering_agent.mdx index 29605edfa59..b374232521d 100644 --- a/product_docs/docs/pem/9/registering_agent.mdx +++ b/product_docs/docs/pem/9/registering_agent.mdx @@ -49,22 +49,22 @@ set PEM_SERVER_PASSWORD=edb | `--pem-server` | The IP address of the PEM backend database server. This parameter is required. | | `--pem-port` | The port of the PEM backend database server. The default value is `5432`. | | `--pem-user` | The name of a database user with `pem_admin` and `rolcreaterole` roles (or a superuser) on the PEM backend database server. This user will be used to connect to the PEM server to perform agent registration. This parameter is required. | -| `--pem-agent-user` | The name of a database user on the PEM backend database server. This user will be used by the agent after registration to open connections to the PEM database server to write probe data, evaluate alerts, etc. This parameter is optional. If omitted, the agent will connect using a new user created during registration named `agent` where `` is the agent ID. Note that this user is always created and even if you specify a `pem-agent-user` the agent will use `SET ROLE agent` to switch roles after the connection is made. | +| `--pem-agent-user` | The name of a database user on the PEM backend database server. After registration, the agent will use this user to open connections to the PEM database server to write probe data, evaluate alerts, etc. This parameter is optional. If omitted, the agent will connect using a new user created during registration named `agent` where `` is the agent ID. Note that this user is always created and even if you specify a `pem-agent-user` the agent will use `SET ROLE agent` to switch roles after the connection is made. | | `--pem-ssl-mode` | The [SSL mode](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION) to be used by the PEM agent user (see above). The possible values are `prefer`, `require`,`disable`,`verify-CA`, and `verify-full`. The default value is `require`. | | `--cert-path` | The complete path to a directory in which certificates will be stored. If you don't provide a path, certificates are created in `~/.pem` on Linux and `%APPDATA%/pem` on Windows. | | `--config-dir` | The directory path for the configuration file. The default is `/../etc`. | | `--display-name` | A user-friendly name for the agent to display in the PEM browser tree. In PEM 9.6 and later, the default is the host's fully qualified domain name (FQDN), falling back to the hostname if this option isn't set. For releases earlier than PEM 9.6, the default is the hostname. | | `--force-registration` | Include the `force-registration` clause to register the agent with the arguments provided. This clause is useful if you're overriding an existing agent configuration. The default value is `Yes`. | | `--group` | The name of a group inw which to place the agent. This parameter is optional, if omitted the agent will not be placed in a group. | -| `--team` | The name of a database role on the PEM backend database server. Access to this agent will be restricted to only the named role, the owner, and the `pem_admin` role. This parameter is optional. If omitted, no team will be assigned meaning all users can access this agent. | -| `--owner` | The name of a database user on the PEM backend database server. This user will be assigned as the owner of the agent. If omitted, the specified `pem-user` will be assigned as the owner. | +| `--team` | The name of a database role on the PEM backend database server. Access to this agent will be restricted to only the named role, the owner, and the `pem_admin` role. This parameter is optional. No team will be assigned if omitted, meaning all users can access this agent. | +| `--owner` | The name of a database user on the PEM backend database server. This user will be assigned as the owner of the agent. The specified `pem-user` will be assigned as the owner if omitted. | | `--allow_server_restart` | Enable the `allow_server_restart` parameter to allow PEM to restart the monitored server. The default value is `True`. | | `--allow-batch-probes` | Enable the `allow-batch-probes` parameter to allow PEM to run batch probes on this agent. The default value is `False`. | | `--batch-script-user` | The operating system user to use for executing the batch/shell scripts. The default value is none. The scripts don't execute if you leave this parameter blank or the specified user doesn't exist. | | `--enable-heartbeat-connection` | Enable the `enable-heartbeat-connection` parameter to create a dedicated heartbeat connection between the PEM agent and server to update the active status. The default value is `False`. | | `--enable-smtp` | Enable the `enable-smtp parameter` to allow the PEM agent to send the email on behalf of the PEM server. The default value is `False`. | | `--enable-snmp` | Enable the `enable-snmp parameter` to allow the PEM agent to send the SNMP traps on behalf of the PEM server. The default value is `False`. | -| `-o` | Used to override the configuration file options. See below for example usage. | +| `-o` | Used to override the configuration file options. See the below [example](#overriding-default-configurations---examples) for usage. | !!! Note Allowing the agent to restart the database server If you use any feature of PEM that requires a database server restart by the PEM agent (such as Audit Manager, Log Manager, or the Tuning Wizard), then you must set the value of `allow_server_restart` to `true` in the `agent.cfg` file or restart the server manually for changes to take effect.