blob: fc47169a789c88c20d91406378f0de30323e664f [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -07001ndnsec-delete
2=============
3
Davide Pesaventob310efb2019-04-11 22:10:24 -04004Synopsis
5--------
Alexander Afanasyev151a8552014-04-11 00:54:43 -07006
Davide Pesavento102f0572024-06-22 15:00:06 -04007**ndnsec delete** [**-h**] [**-k**\|\ **-c**] *name*
Alexander Afanasyev151a8552014-04-11 00:54:43 -07008
9Description
10-----------
11
Davide Pesavento102f0572024-06-22 15:00:06 -040012This command allows deleting security data from both the
13**Public Information Base (PIB)** and the **Trusted Platform Module (TPM)**.
Alexander Afanasyev151a8552014-04-11 00:54:43 -070014
Davide Pesavento102f0572024-06-22 15:00:06 -040015By default, *name* is interpreted as an identity name.
Davide Pesaventob310efb2019-04-11 22:10:24 -040016If an identity is deleted, all keys and certificates belonging to that identity
17will be deleted as well. If a key is deleted, all certificates associated with
18that key will be deleted as well.
Yingdi Yu6147ef42014-12-08 17:48:32 -080019
Alexander Afanasyev151a8552014-04-11 00:54:43 -070020Options
21-------
22
Davide Pesaventob310efb2019-04-11 22:10:24 -040023.. option:: -k, --delete-key
Alexander Afanasyev151a8552014-04-11 00:54:43 -070024
Davide Pesaventob310efb2019-04-11 22:10:24 -040025 Interpret *name* as a key name and delete the key and its associated data.
26
27.. option:: -c, --delete-cert
28
29 Interpret *name* as a certificate name and delete the certificate.
Alexander Afanasyev151a8552014-04-11 00:54:43 -070030
Yingdi Yu6147ef42014-12-08 17:48:32 -080031Exit Status
32-----------
33
34Normally, the exit status is 0 if the requested entity is deleted successfully.
35If the entity to be deleted does not exist, the exit status is 1.
Davide Pesavento102f0572024-06-22 15:00:06 -040036For any other errors, the exit status is 2.
Yingdi Yu6147ef42014-12-08 17:48:32 -080037
Davide Pesavento102f0572024-06-22 15:00:06 -040038Examples
39--------
Alexander Afanasyev151a8552014-04-11 00:54:43 -070040
Davide Pesavento102f0572024-06-22 15:00:06 -040041Delete all data related to the identity ``/ndn/test/david``::
Alexander Afanasyev151a8552014-04-11 00:54:43 -070042
Davide Pesavento102f0572024-06-22 15:00:06 -040043 $ ndnsec delete /ndn/test/david
44
45See Also
46--------
47
48:manpage:`ndnsec-list(1)`