1tss2_setdescription(1)      General Commands Manual     tss2_setdescription(1)
2
3
4

NAME

6       tss2_setdescription(1)
7

SYNOPSIS

9       tss2_setdescription [OPTIONS]
10

SEE ALSO

12       fapi-config(5)  to  adjust  Fapi parameters like the used cryptographic
13       profile and TCTI or directories for the Fapi metadata storages.
14
15       fapi-profile(5) to determine the cryptographic algorithms  and  parame‐
16       ters for all keys and operations of a specific TPM interaction like the
17       name hash algorithm, the asymmetric signature algorithm, scheme and pa‐
18       rameters and PCR bank selection.
19

DESCRIPTION

21       tss2_setdescription(1) - This command allows an application to assign a
22       human readable description to an object in  the  FAPI  metadata  store.
23       The  stored  data can be returned with tss2_getdescription.  Previously
24       stored data is overwritten by this function.  If an  empty  description
25       is passed in, the stored data is deleted.
26

OPTIONS

28       These are the available options:
29
30       • -i, --description=STRING:
31
32         The data to be stored as description for the object.  Optional param‐
33         eter.  Previously stored descriptions are overwritten by  this  func‐
34         tion.  If omitted any stored description is deleted.
35
36       • -p, --path=STRING:
37
38         The path of the object for which the description will be stored.
39

COMMON OPTIONS

41       This  collection of options are common to all tss2 programs and provide
42       information that many users may expect.
43
44       • -h, --help [man|no-man]: Display the tools manpage.  By  default,  it
45         attempts  to  invoke  the  manpager for the tool, however, on failure
46         will output a short tool summary.  This is the same behavior  if  the
47         “man”  option argument is specified, however if explicit “man” is re‐
48         quested, the tool will provide errors from man  on  stderr.   If  the
49         “no-man”  option  if  specified, or the manpager fails, the short op‐
50         tions will be output to stdout.
51
52         To successfully use the manpages feature requires the manpages to  be
53         installed or on MANPATH, See man(1) for more details.
54
55       • -v,  --version:  Display version information for this tool, supported
56         tctis and exit.
57

EXAMPLE

59              tss2_setdescription --path=HS/SRK --description=description
60

RETURNS

62       0 on success or 1 on failure.
63

BUGS

65       Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
66

HELP

68       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
69
70
71
72tpm2-tools                        APRIL 2019            tss2_setdescription(1)