Skip to content

Commit

Permalink
[cli] update coaps readme (#9849)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrhodie authored Feb 14, 2024
1 parent e029417 commit 9b36a42
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/cli/README_COAPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,16 @@ Sets the content sent by the test resource.
Done
```

### start
### start \[check-peer-cert\|max-conn-attempts\]

Starts the application coaps service.

- checkPeerCert: Peer Certificate Check can be disabled by typing false.
The `check-peer-cert` parameter determines if the peer-certificate check is enabled (default) or disabled. The `max-conn-attempts` parameter sets the maximum number of allowed attempts, successful or failed, to connect to the CoAP Secure server. The default value of this parameter is 0, which means that there is no limit to the number of attempts. The `check-peer-cert` and `max-conn-attempts` parameters work together in the following combinations, even though you can only specify one argument:

- No argument specified: Defaults are used.
- Setting `check-peer-cert` to `true`: Has the same effect as as omitting the argument, which is that the `check-peer-cert` value is `true`, and the `max-conn-attempts` value is 0.
- Setting `check-peer-cert` to `false`: `check-peer-cert` value is `false`, and the `max-conn-attempts` value is `0`.
- Specifying a number: `check-peer-cert` is `true`, and the `max-conn-attempts` value is the number specified in the argument.

```bash
> coaps start
Expand Down

0 comments on commit 9b36a42

Please sign in to comment.