Skip to content

Commit 5731b86

Browse files
committed
docs: add README entry for new command
1 parent 6972240 commit 5731b86

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ omnect-cli is a command-line tool to manage omnect-os empowered devices. It prov
77
- Identity configuration:
88
- Inject general identity configuration for AIS (Azure Identity Service)
99
- Inject a device certificate and key
10+
- Inject edge CA certificate for device/server certificate creation
1011
- Device Update for IoT Hub:
1112
- manage updates (create, import, remove) (https://learn.microsoft.com/en-us/azure/iot-hub-device-update/import-concepts)
1213
- inject configuration file `du-config.json` (https://docs.microsoft.com/en-us/azure/iot-hub-device-update/device-update-configuration-file)
@@ -82,7 +83,7 @@ omnect-cli identity set-device-certificate --help
8283
**Note1**: "device_id" has to match the `registration_id` respectively the `device_id` configured in `config.toml`.<br>
8384
**Note2**: see [`config.toml.est.template`](conf/config.toml.est.template) as a corresponding `config.toml` in case of using `EST service`.
8485

85-
#### Get full-chain intermediate certificate and key for existing OMNECT PKI
86+
#### Get full-chain intermediate certificate and key for existing AMNESTY PKI
8687
Please get into contact with us in case you want to use our existing cloud services for device provisioning. We can provide certificate and key file to configure your device.
8788

8889
#### Generate your own full-chain intermediate certificate and key
@@ -103,6 +104,20 @@ omnect-cli identity set-device-certificate-no-est --help
103104
**Note1**: "device_id" has to match the `registration_id` respectively the `device_id` configured in `config.toml`.<br>
104105
**Note2**: see [`config.toml.no-est.template`](conf/config.toml.no-est.template) as a corresponding `config.toml` in case of using `EST service`.
105106

107+
### Inject edge CA certificate for module device/server certificate generation
108+
109+
Generate and set edge CA certificate for the generation of device and server
110+
certificates. Technically, this command functions similarly `set-device-identity`:
111+
112+
1. generates device specific credentials from a given intermediate certificate and key
113+
2. injects credentials into a firmware image
114+
115+
Detailed description:
116+
```sh
117+
omnect-cli identity set-edge-ca-certificate --help
118+
```
119+
**Note**: "device_id" has to match the `registration_id` respectively the `device_id` configured in `config.toml`.<br>
120+
106121
## Device Update for IoT Hub
107122
### Create import manifest
108123
This command creates the device update import manifest which is used later by the `import-update` command.

0 commit comments

Comments
 (0)