---
name: "Fapi_CreateNv"
section: "3"
platform: "linux"
package: "tpm2-tss"
version: "4.2.0-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Fapi_CreateNv"
---

# Fapi\_CreateNv(3)

Fapi\_CreateNv

## NAME

Fapi\_CreateNv - Fapi\_CreateNv

## SYNOPSIS

### Functions

TSS2\_RC **Fapi\_CreateNv** (**FAPI\_CONTEXT** \*context, char const \*path, char const \*type, size\_t size, char const \*policyPath, char const \*authValue)\
 TSS2\_RC **Fapi\_CreateNv\_Async** (**FAPI\_CONTEXT** \*context, char const \*path, char const \*type, size\_t size, char const \*policyPath, char const \*authValue)\
 TSS2\_RC **Fapi\_CreateNv\_Finish** (**FAPI\_CONTEXT** \*context)\

## Detailed Description

FAPI functions to invoke CreateNv either as one-call or in an asynchronous manner.

## Function Documentation

### TSS2\_RC Fapi\_CreateNv (FAPI\_CONTEXT \* context, char const \* path, char const \* type, size\_t size, char const \* policyPath, char const \* authValue)

One-Call function for Fapi\_CreateNv

This command creates an NV index in the TPM using a given path and type.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *path* The path to the new NV index \
 *type* The intended type of the new NV index. May be NULL \
 *size* The size of the new NV index in bytes. May be 0 if the size is inferred from the type \
 *policyPath* The path to the policy that is associated with the new NV index. May be NULL \
 *authValue* The authorization value that is associated with the new NV index. May be NULL

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or path is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_PATH\_ALREADY\_EXISTS* if an NV index already exists at path. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if type is non-NULL but invalid or does not match the size. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if policyPath is non-NULL and does not map to a FAPI policy or if path dos not refer to a valid NV index path. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_NO\_TPM* if FAPI was initialized in no-TPM-mode via its config file. \
 *TSS2\_FAPI\_RC\_TRY\_AGAIN* if an I/O operation is not finished yet and this function needs to be called again. \
 *TSS2\_FAPI\_RC\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization. \
 *TSS2\_FAPI\_RC\_KEY\_NOT\_FOUND* if a key was not found. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_NV\_TOO\_SMALL* if too many NV handles are defined. \
 *TSS2\_FAPI\_RC\_AUTHORIZATION\_UNKNOWN* if a required authorization callback is not set. \
 *TSS2\_FAPI\_RC\_AUTHORIZATION\_FAILED* if the authorization attempt fails. \
 *TSS2\_FAPI\_RC\_POLICY\_UNKNOWN* if policy search for a certain policy digest was not successful. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI. \
 *TSS2\_FAPI\_RC\_NOT\_PROVISIONED* FAPI was not provisioned.

### TSS2\_RC Fapi\_CreateNv\_Async (FAPI\_CONTEXT \* context, char const \* path, char const \* type, size\_t size, char const \* policyPath, char const \* authValue)

Asynchronous function for Fapi\_CreateNv

This command creates an NV index in the TPM using a given path and type.

Call Fapi\_CreateNv\_Finish to finish the execution of this command.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *path* The path to the new NV index \
 *type* The intended type of the new NV index. May be NULL \
 *size* The size of the new NV index in bytes. May be 0 if the size is inferred from the type \
 *policyPath* The path to the policy that is associated with the new NV index. May be NULL \
 *authValue* The authorization value that is associated with the new NV index. May be NULL

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or path is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_PATH\_ALREADY\_EXISTS* if an NV index already exists at path. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if type is non-NULL but invalid or does not match the size. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if policyPath is non-NULL and does not map to a FAPI policy or if path dos not refer to a valid NV index path. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_NO\_TPM* if FAPI was initialized in no-TPM-mode via its config file. \
 *TSS2\_FAPI\_RC\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization.

### TSS2\_RC Fapi\_CreateNv\_Finish (FAPI\_CONTEXT \* context)

Asynchronous finish function for Fapi\_CreateNv

This function should be called after a previous Fapi\_CreateNv\_Async.

**Parameters**

*context* The **FAPI\_CONTEXT**

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_TRY\_AGAIN* if the asynchronous operation is not yet complete. Call this function again later. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function. \
 *TSS2\_FAPI\_RC\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization. \
 *TSS2\_FAPI\_RC\_KEY\_NOT\_FOUND* if a key was not found. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if a path is used in inappropriate context or contains illegal characters. \
 *TSS2\_FAPI\_RC\_NV\_TOO\_SMALL* if too many NV handles are defined. \
 *TSS2\_FAPI\_RC\_AUTHORIZATION\_UNKNOWN* if a required authorization callback is not set. \
 *TSS2\_FAPI\_RC\_AUTHORIZATION\_FAILED* if the authorization attempt fails. \
 *TSS2\_FAPI\_RC\_POLICY\_UNKNOWN* if policy search for a certain policy digest was not successful. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI. \
 *TSS2\_FAPI\_RC\_NOT\_PROVISIONED* FAPI was not provisioned. \
 *TSS2\_FAPI\_RC\_PATH\_ALREADY\_EXISTS* if the object already exists in object store.

## Author

Generated automatically by Doxygen for tpm2-tss from the source code.