<a id="hook-command-opened-ports"></a>

# `opened-ports`

## Summary

Lists all ports or port ranges opened by the unit.

## Usage

```text
opened-ports [options]
```

### Options

| Flag             | Default   | Usage                                                                  |
|------------------|-----------|------------------------------------------------------------------------|
| `--endpoints`    | false     | Displays the list of target application endpoints for each port range. |
| `--format`       | smart     | Specify output format (json|smart|yaml)                                |
| `-o`, `--output` |           | Specify an output file                                                 |

## Examples

```none
opened-ports
```

## Details

`opened-ports` lists all ports or port ranges opened by a unit.

By default, the port range listing does not include information about the
application endpoints that each port range applies to. Each list entry is
formatted as `<port>/<protocol>` (e.g., `80/tcp`)
or `<from>-<to>/<protocol>`(e.g., `8080-8088/udp`).

If the `--endpoints` option is specified, each entry in the port list will be
augmented with a comma-delimited list of endpoints that the port range
applies to (e.g. `80/tcp (endpoint1, endpoint2)` ). If a port range applies to
all endpoints, this will be indicated by the presence of a `*` character
(e.g. `80/tcp (*)` ).

Opening ports is transactional (i.e. will take place on successfully exiting
the current hook), and therefore `opened-ports` will not return any values for
pending open-port operations run from within the same hook.
