Introduction
Remote commands provide an easy way to get a few details about a resource from OpsRamp portal without logging in to the resource.
Prerequisites
- Clients should have “Remediation and Automation” package and “Remote Access Management” Addon.
- Users should have “Allow to Run Commands” permission to run the remote commands.
Supported Remote Commands
To see the supported remote commands in OpsRamp portal, follow the below steps:
- Go to Infrastructure > Resources.
- Choose the agent installed resource to run the remote commands, or use the advanced search field to find the resource.
- Click on the resource.
- Next, navigate to the right top corner of the page and click on symbol (
>_
). - Now you will see the complete list of supported remote commands as shown in below table.
List of remote commands name with supported Operating System (OS);
Remote Commands | Description | Windows | Linux | FreeBSD |
---|---|---|---|---|
CPU and Memory Usage | This remote command gives CPU and Memory Usage of the resource. | Yes | Yes | Yes |
Disable Windows Auto Update | This remote command is used to disable automatic updates in windows. | Yes | No | No |
Disk Usage | This remote command is used to get Disk Usage on a resource. | Yes | Yes | Yes |
Enable Agent log Debug Mode | This remote command is used to enable debug mode on agent log. You can select the time duration from the dropdown options (10,30 or 60 minutes). Once the time period is complete, the agent log level returns to WARNING level. | Yes | Yes | Yes | Critical and Error Event logs | This remote command is used to get the list of errors and critical events triggered based on the time period specified. | Yes | No | No | Hostname | It is used to get the hostname of the resource. | Yes | Yes | Yes | Internal Agent Command | Internal agent commands are used to get information and to perform action. Below are the possible options for agent internal commands: SYNC_MONIT_CONFIGS POST_INVENTORY | Yes | Yes | Yes | IPConfig | This remote command is used to get the IpAddress of the resource. | Yes | Yes | Yes | NSLookup | NSLookup command is useful for querying the Domain Name System (DNS) to obtain domain name or IP address mapping or any other specific DNS record. | Yes | Yes | No | Ping | This remote command is used to check whether given IP is reachable or not. | Yes | Yes | Yes | Processes | This remote command shows a list of processes and basic information of each process. | Yes | Yes | Yes | RDP and VNC Options | This remote command is used to get RDP (Remote Desktop Protocal) and VNC (Virtual Network Computing) information. This is used to check whether RDP and VNC is enabled or not in the device. | Yes | No | No | Restart Agent | Restart Agent is used to restart agent service. | Yes | Yes | Yes | Restart Remote Agent | This remote command is used to restart the remote Windows agent. You must provide the remote RDP credentials. | Yes | No | No | Remote System Info | This remote command is used to get information about remote devices. It provides details of hostname, OS name, OS version etc. | Yes | No | No | Services | This remote command is used to list services and their basic information. | Yes | Yes | Yes | Show Recent Agent Log | This remote command is used to get the recent agent logs up to 500 lines. You can choose 100, 200, or 500 using the dropdown list. | Yes | Yes | Yes | System Info | System Info command is used to get information of a system. It provides information such as: hostname, OS Name, OS version etc. | Yes | Yes | Yes | System Status | System Info command is used to get information about a system. It provides information such as: hostname, OS Name, OS version etc. | Yes | No | No | Trace Route | Trace Route is used to display possible routes and measure transit delays of packets across an Internet Protocol Network. | Yes | Yes | Yes | Execute a Command | This remote command is visible for Partner and Client users. | Yes | Yes | No |
List of gateway commands that can be executed via Agent installed on the gateway.
Remote Commands | Description |
---|---|
Kubectl Get Pods | This command gets the kubernetes POD details from NextGen gateway. |
Kubectl Get Services | This command gets the kubernetes Services details from NextGen gateway. |
Kubectl Get PVC | This command gets the kubernetes persistent volume details from NextGen gateway. |
Kubectl Get Nodes | This command gets the kubernetes nodes details from NextGen gateway. |
Kubectl Top Pods | This command gets the kubernetes pod memory usage from NextGen gateway. |
Kubectl Delete Pod NextGen Gateway | This command is used to delete the pod in NextGen gateway. |
Kubectl Descr Pod NextGen Gw | This command describes the kubernetes Nextgen gateway pod on the NextGen gateway. |
Kubectl Descr Pod NextGen Gw Redis Master | This command describes the kubernetes Nextgen gateway redid master pod on the NextGen gateway. |
Kubectl Describe Node | This command describes the kubernetes Node on the NextGen gateway. |
Kubectl Top Pods NextGen Gateway Containers | This command gets the kubernetes pod container memory usage from NextGen gateway. |
Openssl | The openssl s_client command implements a generic SSL/TLS client which connects to a remote host using SSL/TLS. It is a very useful diagnostic tool for SSL servers. |
Restart Vprobe | This command is used to restart the classic gateway vprobe service (monitoring service). |
Monit Summary | This command is used to check the classic gateway services status, following are the services vprobe, web probe, Django, nginx, etc. |
Show Recent NextGen GW Vprobe and Tls Log | This command is used to get Nextgen gateway vprobe and vprobe tls logs, if you select 100 line you will see last 100 lines of vprobe and vprobe tls logs. |
Show Recent Classic GW Vprobe Log | This command is used to get classic gateway vprobe logs, if you select 100 lines you will see the last 100 lines of vprobe logs. |
Show Recent Classic GW Tls Log | This command is used to get classic gateway vprobe tls logs, if you select 100 line you will see the last 100 lines of vprobe tls logs. |
Note
- These commands are accessible only to Service Provider users and gateway devices.
- To access these commands, contact the OpsRamp support team and request to enable the “enable_gateway_cmd_via_agent” flag.