---
schema_version: "1"
id: cf647b1279c628abdec21498e94f84e801c23105e81e63292c75d99763d9d1a0
title: RTFCTL Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/runtime-fabric/2.9/rtfctl-reference.md
canonical_url: https://docs.mulesoft.com/runtime-fabric/2.9/rtfctl-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: bda6ef38e49dc52a9c1446556d331f8c26bfd53bc70022c6bfeeb0969e8ec608
description: MuleSoft Documentation Site
release: "2.9"
latest: false
---
---
product: Runtime Fabric
version: 2.9
---

# RTFCTL Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use this reference for `rtfctl` commands.

## Install, Upgrade, Back up, or Restore Runtime Fabric with RTFCTL

Use these commands to install, upgrade, back up or restore a Runtime Fabric.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#get"><code>get</code></a></p></div></div></td><td><div><div><p>Displays one or more resources</p></div></div></td></tr><tr><td><div><div><p><a href="#ping"><code>ping</code></a></p></div></div></td><td><div><div><p>Tests network connectivity</p></div></div></td></tr><tr><td><div><div><p><a href="#report"><code>report</code></a></p></div></div></td><td><div><div><p>Generates a diagnostics report</p></div></div></td></tr><tr><td><div><div><p><a href="#status"><code>status</code></a></p></div></div></td><td><div><div><p>Displays the status of Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#test"><code>test</code></a></p></div></div></td><td><div><div><p>Verifies outbound network connectivity to the Runtime Fabric control plane</p></div></div></td></tr></tbody></table>

### get

Displays one or more resources

- Prints a list of all applications in all environments

  rtfctl get apps --namespace <rtf\_namespace>

- Prints a list of all applications in a specific environment

  rtfctl get apps --app-namespace <app\_namespace> --namespace <rtf\_namespace>

- Displays an HTTP proxy configurations

  rtfctl get http-proxy --namespace <rtf\_namespace>

- Displays a monitoring proxy configuration

  rtfctl get monitoring-proxy --namespace <rtf\_namespace>

- Displays secure properties

  rtfctl get secure-properties --app-namespace <app\_namespace> --namespace <rtf\_namespace>

- Displays the Mule license

  rtfctl get mule-license --namespace <rtf\_namespace>

- Displays Runtime Fabric registry credentials

  rtfctl get registry-credentials <activation\_data>

### ping

Tests network connectivity

- Pings example.com from inside an application, using the first replica by default

  rtfctl ping <app\_name> <host\_or\_ip\_address> --app-namespace <app\_namespace> --namespace
  <rtf\_namespace>

- Attempts to connect to example.com on port `12345` from inside an application, using the first
  replica by default

  rtfctl ping <app\_name> <host\_or\_ip\_address> --port <port> --app-namespace <app\_namespace>
  --namespace <rtf\_namespace>

### report

Generates a diagnostics report at `rtf-report.tar.gz`

rtfctl report --namespace <rtf\_namespace>

Run rtfctl report tasks in parallel by using the `workers` flag that controls the number of tasks to
run in parallel. The default value is 10.

rtfctl report --workers <num\_of\_workers>

Faster compression of the tarball generated by `rtfctl report` with the `--use-fast-compression`
flag. The default value is false.

rtfctl report --use-fast-compression=true

Select which application namespaces to include in the report besides the installation namespace by
using the `--namespaces` flag. The flag controls what to include in the reports and can result in
faster collection if only selected namespaces are reported.

# Reports rtf installation default namespace (rtf)

rtfctl report

# Reports only <rtf\_namespace>

rtfctl report -n <rtf\_namespace>

# Reports for <app\_namespace\_1> and <app\_namespace\_2> application namespaces that belong to <rtf\_namespace>

rtfctl report -n <rtf\_namespace> --app-namespaces <app\_namespace\_1>,<app\_namespace\_2> rtfctl
report -n <rtf\_namespace> --app-namespaces <app\_namespace\_1> --app-namespaces <app\_namespace\_2>

# Report for all application namespaces that belong to <rtf\_namespace>

rtfctl report -n <rtf\_namespace> --app-namespaces all

Specifies the name of the helm release to support installations using custom release names.

rtfctl report --release-name <agentReleaseName>

### status

Displays the status of Runtime Fabric

- Displays status output in JSON

  rtfctl status --output json --namespace <rtf\_namespace>

- Checks Kubernetes DNS health

  rtfctl status dns-check --node-label "<k>:<v>"

### test

Verifies outbound network connectivity to the Runtime Fabric control plane.

- Schedules a check on any nodes

  rtfctl test outbound-network --namespace <rtf\_namespace>

- Schedules a check the nodes satisfying the `node-label` parameter

  rtfctl test outbound-network --node-label "<k>:<v>" --namespace <rtf\_namespace>

- Schedules a check on all nodes

  rtfctl test outbound-network --all --namespace <rtf\_namespace>

## Configure Runtime Fabric with RTFCTL

Use these commands to configure Runtime Fabric.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#apply"><code>apply</code></a></p></div></div></td><td><div><div><p>Applies changes to a Runtime Fabric configuration</p></div></div></td></tr><tr><td><div><div><p><a href="#update"><code>update</code></a></p></div></div></td><td><div><div><p>Updates rtfctl</p></div></div></td></tr><tr><td><div><div><p><a href="#wait"><code>wait</code></a></p></div></div></td><td><div><div><p>Waits for Runtime Fabric components to become ready</p></div></div></td></tr><tr><td><div><div><p><a href="#renew"><code>renew-expired-client-cert</code></a></p></div></div></td><td><div><div><p>Renews an expired client certificate using a pre-downloaded package</p></div></div></td></tr></tbody></table>

### apply

Applies changes to a Runtime Fabric configuration.

> [!NOTE] You can use the `rtfctl apply system-configuration` command to update OpenShift
> system-configuration values. Other rtfctl apply commands are not effective for OpenShift. For any
> other updates, modify the values in the OpenShift console.

- Applies an HTTP proxy configuration

  rtfctl apply http-proxy http://<host>:<port> --namespace <rtf\_namespace>

- Applies an HTTP proxy configuration with hostnames bypassing the proxy

  rtfctl apply http-proxy http://<host>:<port> --no-proxy "DOMAIN1.com,DOMAIN2.com" --namespace
  <rtf\_namespace>

- Applies an HTTP proxy configuration with authentication

  rtfctl apply http-proxy http://<username>:<password>@<host>:<port> --namespace <rtf\_namespace>

- Clears an HTTP proxy configuration

  rtfctl apply http-proxy "" --no-proxy "" --namespace <rtf\_namespace>

- Applies a secure property

  rtfctl apply secure-property --key <key> --value <value> --app-namespace <app\_namespace>
  --namespace <rtf\_namespace>

- Applies a system configuration on a host node

  rtfctl apply system-configuration

- Applies a system configuration on a host node without downloading the latest scripts

  rtfctl apply system-configuration --skip-download

- Applies a Mule license

  rtfctl apply mule-license <base64\_encoded\_license> --namespace <rtf\_namespace>

  If Runtime Fabric is installed via Helm, you must update the `mule-license` property in the Helm
  values.

- Applies a monitoring proxy

  rtfctl apply monitoring-proxy http://<host>:<port> --namespace <rtf\_namespace>

- Clears a monitoring proxy configuration

  rtfctl apply monitoring-proxy "" --namespace <rtf\_namespace>

### update

Updates `rtfctl`.

- Updates from the US control plane

  rtfctl update

- Updates `rtfctl` from the EU control plane

  rtfctl update --host eu1.anypoint.mulesoft.com

### wait

Waits for Runtime Fabric components to become ready

- Specifies the number of seconds to wait

rtfctl wait <value\_in\_seconds> --namespace <rtf\_namespace>

- Specifies the number of seconds to pass before timing out the wait (Default is 600 seconds)

rtfctl wait --timeout <value\_in\_seconds> --namespace <rtf\_namespace>

### renew

Renews an expired client certificate using a pre-downloaded package

rtfctl renew-expired-client-cert <cert-bundle-filename>

## Troubleshoot Runtime Fabric with RTFCTL

Use these commands to troubleshoot Runtime Fabric.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#get"><code>get</code></a></p></div></div></td><td><div><div><p>Displays one or more resources</p></div></div></td></tr><tr><td><div><div><p><a href="#ping"><code>ping</code></a></p></div></div></td><td><div><div><p>Tests network connectivity</p></div></div></td></tr><tr><td><div><div><p><a href="#report"><code>report</code></a></p></div></div></td><td><div><div><p>Generates a diagnostics report</p></div></div></td></tr><tr><td><div><div><p><a href="#status"><code>status</code></a></p></div></div></td><td><div><div><p>Displays the status of Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#test"><code>test</code></a></p></div></div></td><td><div><div><p>Verifies outbound network connectivity to the Runtime Fabric control plane</p></div></div></td></tr></tbody></table>

### get

Displays one or more resources

- Prints a list of all applications in all environments

  rtfctl get apps --namespace <rtf\_namespace>

- Prints a list of all applications in a specific environment

  rtfctl get apps --app-namespace <app\_namespace> --namespace <rtf\_namespace>

- Displays an HTTP proxy configurations

  rtfctl get http-proxy --namespace <rtf\_namespace>

- Displays a monitoring proxy configuration

  rtfctl get monitoring-proxy --namespace <rtf\_namespace>

- Displays secure properties

  rtfctl get secure-properties --app-namespace <app\_namespace> --namespace <rtf\_namespace>

- Displays the Mule license

  rtfctl get mule-license --namespace <rtf\_namespace>

- Displays Runtime Fabric registry credentials

  rtfctl get registry-credentials <activation\_data>

### ping

Tests network connectivity

- Pings example.com from inside an application, using the first replica by default

  rtfctl ping <app\_name> <host\_or\_ip\_address> --app-namespace <app\_namespace> --namespace
  <rtf\_namespace>

- Attempts to connect to example.com on port `12345` from inside an application, using the first
  replica by default

  rtfctl ping <app\_name> <host\_or\_ip\_address> --port <port> --app-namespace <app\_namespace>
  --namespace <rtf\_namespace>

### report

Generates a diagnostics report at `rtf-report.tar.gz`

rtfctl report --namespace <rtf\_namespace>

Run rtfctl report tasks in parallel by using the `workers` flag that controls the number of tasks to
run in parallel. The default value is 10.

rtfctl report --workers <num\_of\_workers>

Faster compression of the tarball generated by `rtfctl report` with the `--use-fast-compression`
flag. The default value is false.

rtfctl report --use-fast-compression=true

Select which application namespaces to include in the report besides the installation namespace by
using the `--namespaces` flag. The flag controls what to include in the reports and can result in
faster collection if only selected namespaces are reported.

# Reports rtf installation default namespace (rtf)

rtfctl report

# Reports only <rtf\_namespace>

rtfctl report -n <rtf\_namespace>

# Reports for <app\_namespace\_1> and <app\_namespace\_2> application namespaces that belong to <rtf\_namespace>

rtfctl report -n <rtf\_namespace> --app-namespaces <app\_namespace\_1>,<app\_namespace\_2> rtfctl
report -n <rtf\_namespace> --app-namespaces <app\_namespace\_1> --app-namespaces <app\_namespace\_2>

# Report for all application namespaces that belong to <rtf\_namespace>

rtfctl report -n <rtf\_namespace> --app-namespaces all

Specifies the name of the helm release to support installations using custom release names.

rtfctl report --release-name <agentReleaseName>

### status

Displays the status of Runtime Fabric

- Displays status output in JSON

  rtfctl status --output json --namespace <rtf\_namespace>

- Checks Kubernetes DNS health

  rtfctl status dns-check --node-label "<k>:<v>"

### test

Verifies outbound network connectivity to the Runtime Fabric control plane.

- Schedules a check on any nodes

  rtfctl test outbound-network --namespace <rtf\_namespace>

- Schedules a check the nodes satisfying the `node-label` parameter

  rtfctl test outbound-network --node-label "<k>:<v>" --namespace <rtf\_namespace>

- Schedules a check on all nodes

  rtfctl test outbound-network --all --namespace <rtf\_namespace>

## Manage Mule Apps on Runtime Fabric with RTFCTL

Use these commands to manage applications deployed to Runtime Fabric.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#delete"><code>delete</code></a></p></div></div></td><td><div><div><p>Deletes a secure property</p></div></div></td></tr><tr><td><div><div><p><a href="#disk"><code>disk</code></a></p></div></div></td><td><div><div><p>Displays disk usage for an application</p></div></div></td></tr><tr><td><div><div><p><a href="#restart"><code>restart</code></a></p></div></div></td><td><div><div><p>Restarts an application</p></div></div></td></tr></tbody></table>

### delete

Deletes a secure property

rtfctl delete secure-property <sample\_key> -n <app\_namespace>

### disk

Displays disk usage for an application

- Displays the disk usage for an application, using the first replica by default

  rtfctl disk <app\_name> --app-namespace <app\_namespace> --namespace <rtf\_namespace>

- Displays the disk usage for an application, using a specific replica

  rtfctl disk <app\_name> --details --pod <replica\_name> --app-namespace <app\_namespace>
  --namespace <rtf\_namespace>

### restart

Restarts an application

rtfctl restart <app\_name> --app-namespace <app\_namespace> --namespace <rtf\_namespace>

## See Also

- [Using RTFCTL Tool Overview](https://docs.mulesoft.com/runtime-fabric/2.9/using-rtfctl)