Skip to content

Commit

Permalink
add explanation and example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
kengelhardt-godaddy committed Jul 13, 2018
1 parent 8a68468 commit abce2f2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -131,6 +131,20 @@ The desired policy. Allowed values are Enum['ACCEPT','DROP', 'REJECT']

the protocol we would like to filter. Allowed values are Enum['icmp', 'tcp', 'udp']

### `proto_options`

The protocol options we would like to add.
The following example will suppress the hostname in programs like `traceroute`:
```yaml
---
ferm::rules:
'drop_output_traceroute':
chain: 'OUTPUT'
policy: 'DROP'
proto: 'icmp'
proto_options: 'icmp-type time-exceeded'
```

#### `comment`

A comment that will be written into the file and into ip(6)tables
Expand Down

0 comments on commit abce2f2

Please sign in to comment.