| description: > |
| NVMe Format interface containing methods and enums for Format command. |
| |
| methods: |
| - name: Format |
| description: > |
| Execute Format NVM operation on the NVMe entity. |
| parameters: |
| - name: LBAFormat |
| type: byte |
| description: > |
| LBA Format index to apply to the NVM media. |
| - name: SecureEraseSetting |
| type: enum[self.SecureEraseSetting] |
| description: > |
| Type of secure erase operation to perform. |
| - name: DataProtectionType |
| type: enum[self.DataProtectionType] |
| description: > |
| End-to-end data protection type to configure. |
| returns: [] |
| errors: |
| - xyz.openbmc_project.Common.Error.InvalidArgument |
| - xyz.openbmc_project.Common.Error.Unavailable |
| - xyz.openbmc_project.Common.Error.NotAllowed |
| |
| enumerations: |
| - name: SecureEraseSetting |
| description: > |
| Secure erase settings for format. |
| values: |
| - name: None |
| description: > |
| No secure erase operation. |
| - name: UserDataErase |
| description: > |
| User Data Erase. |
| - name: CryptoErase |
| description: > |
| Cryptographic Erase. |
| - name: DataProtectionType |
| description: > |
| Data protection type. |
| values: |
| - name: None |
| description: > |
| Protection information is not enabled. |
| - name: Type1 |
| description: > |
| Protection information is enabled, Type 1. |
| - name: Type2 |
| description: > |
| Protection information is enabled, Type 2. |
| - name: Type3 |
| description: > |
| Protection information is enabled, Type 3. |
