Skip to content

Commit

Permalink
chore(docs): Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: spbsoluble <[email protected]>
  • Loading branch information
spbsoluble committed Oct 23, 2024
1 parent 6ee8959 commit e8ccb3a
Show file tree
Hide file tree
Showing 58 changed files with 133 additions and 63 deletions.
21 changes: 14 additions & 7 deletions cmd/inventory.go
Original file line number Diff line number Diff line change
Expand Up @@ -599,13 +599,20 @@ var inventoryRemoveCmd = &cobra.Command{
}

var inventoryFixRFPKCS12 = &cobra.Command{
Use: "fixrfpkcs12",
Aliases: nil,
SuggestFor: nil,
Short: "Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.",
GroupID: "",
Long: `Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.`,
Example: "",
Use: "fixrfpkcs12",
Aliases: nil,
SuggestFor: nil,
Short: "Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.",
GroupID: "",
Long: `Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.`,
Example: `
# The below will create a CSV file that can be reviewed and modified before running the command with the --file option.
kfutil stores inventory fixrfpkcs12
# The below will read the CSV file and schedule remove jobs as specified in the file where the 'Action' col is "REMOVE".
# The --force flag is *required* to actually schedule the remove jobs for the certificates.
kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force
`,
ValidArgs: nil,
ValidArgsFunction: nil,
Args: nil,
Expand Down
2 changes: 1 addition & 1 deletion docs/kfutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ A CLI wrapper around the Keyfactor Platform API.
* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.
* [kfutil version](kfutil_version.md) - Shows version of kfutil

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ See each sub-command's help for details on how to use the generated script.
* [kfutil completion powershell](kfutil_completion_powershell.md) - Generate the autocompletion script for powershell
* [kfutil completion zsh](kfutil_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ kfutil completion bash

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ kfutil completion fish [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ kfutil completion powershell [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ kfutil completion zsh [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
* [kfutil containers get](kfutil_containers_get.md) - Get certificate store container by ID or name.
* [kfutil containers list](kfutil_containers_list.md) - List certificate store containers.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_containers_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil containers get [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_containers_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil containers list [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ kfutil export [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
* [kfutil](kfutil.md) - Keyfactor CLI utilities
* [kfutil helm uo](kfutil_helm_uo.md) - Configure the Keyfactor Universal Orchestrator Helm Chart

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_helm_uo.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension

* [kfutil helm](kfutil_helm.md) - Helm utilities for configuring Keyfactor Helm charts

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ kfutil import [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ kfutil login [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil logout [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ A collections of APIs and utilities for interacting with Keyfactor orchestrators
* [kfutil orchs logs](kfutil_orchs_logs.md) - Get orchestrator logs by machine/client name.
* [kfutil orchs reset](kfutil_orchs_reset.md) - Reset orchestrator by machine/client name.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_approve.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil orchs approve [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_disapprove.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil orchs disapprove [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ ext -t <token> -e <extension>@<version>,<extension>@<version> -o ./app/extension

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil orchs get [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil orchs list [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil orchs logs [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_orchs_reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil orchs reset [flags]

* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ programmatically create, delete, edit, and list PAM Providers.
* [kfutil pam types-list](kfutil_pam_types-list.md) - Returns a list of all available PAM provider types.
* [kfutil pam update](kfutil_pam_update.md) - Updates an existing PAM Provider, currently only supported from file.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil pam create [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil pam delete [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil pam get [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil pam list [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_types-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ kfutil pam types-create [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_types-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil pam types-list [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_pam_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil pam update [flags]

* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil status [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_store-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
* [kfutil store-types list](kfutil_store-types_list.md) - List certificate store types.
* [kfutil store-types templates-fetch](kfutil_store-types_templates-fetch.md) - Fetches store type templates from Keyfactor's Github.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
4 changes: 2 additions & 2 deletions docs/kfutil_store-types_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ kfutil store-types create [flags]
-b, --git-ref string The git branch or tag to reference when pulling store-types from the internet. (default "main")
-h, --help help for create
-l, --list List valid store types.
-n, --name string Short name of the certificate store type to get. Valid choices are: AKV, AzureApp, AzureAppGW, AzureSP, Fortigate, HCVKV, HCVKVJKS, HCVKVP12, HCVKVPEM, HCVKVPFX, HCVPKI, IISU, K8SCert, K8SCluster, K8SJKS, K8SNS, K8SPKCS12, K8SSecret, K8STLSSecr, RFDER, RFJKS, RFKDB, RFORA, RFPEM, RFPkcs12, SAMPLETYPE, Signum, VMware-NSX, WinCerMgmt, WinCert
-n, --name string Short name of the certificate store type to get. Valid choices are: AKV, AWS-ACM, Akamai, AppGwBin, AzureApp, AzureAppGw, AzureSP, BIPCamera, CiscoAsa, CitrixAdc, F5-BigIQ, F5-CA-REST, F5-SL-REST, F5-WS-REST, Fortigate, GCPLoadBal, GcpCertMgr, HCVKV, HCVKVJKS, HCVKVP12, HCVKVPEM, HCVKVPFX, HCVPKI, IISU, Imperva, K8SCert, K8SCluster, K8SJKS, K8SNS, K8SPKCS12, K8SSecret, K8STLSSecr, MOST, Nmap, PaloAlto, RFDER, RFJKS, RFKDB, RFORA, RFPEM, RFPkcs12, SAMPLETYPE, Signum, VMware-NSX, WinCerMgmt, WinCert, WinSql
```

### Options inherited from parent commands
Expand All @@ -44,4 +44,4 @@ kfutil store-types create [flags]

* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_store-types_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ kfutil store-types delete [flags]

* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_store-types_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ kfutil store-types get [-i <store-type-id> | -n <store-type-name>] [-b <git-ref>

* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_store-types_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil store-types list [flags]

* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_store-types_templates-fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil store-types templates-fetch [flags]

* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
* [kfutil stores list](kfutil_stores_list.md) - List certificate stores.
* [kfutil stores rot](kfutil_stores_rot.md) - Root of trust utility

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ kfutil stores delete [flags]

* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ kfutil stores export [flags]

* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kfutil stores get [flags]

* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Tools for generating import templates and importing certificate stores
* [kfutil stores import csv](kfutil_stores_import_csv.md) - Create certificate stores from CSV file.
* [kfutil stores import generate-template](kfutil_stores_import_generate-template.md) - For generating a CSV template with headers for bulk store creation.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_import_csv.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ kfutil stores import csv --file <file name to import> --store-type-id <store typ

* [kfutil stores import](kfutil_stores_import.md) - Import a file with certificate store parameters and create them in keyfactor.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_import_generate-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ kfutil stores import generate-template --store-type-id <store type id> --store-t

* [kfutil stores import](kfutil_stores_import.md) - Import a file with certificate store parameters and create them in keyfactor.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
4 changes: 3 additions & 1 deletion docs/kfutil_stores_inventory.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ Commands related to certificate store inventory management

* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.
* [kfutil stores inventory add](kfutil_stores_inventory_add.md) - Adds one or more certificates to one or more certificate store inventories.
* [kfutil stores inventory fixrfpkcs12](kfutil_stores_inventory_fixrfpkcs12.md) - Fix RFPKCS12 stores that contain 2
or more leaf certificates, by removing the certificate with the earliest issued date.
* [kfutil stores inventory remove](kfutil_stores_inventory_remove.md) - Removes a certificate from the certificate store inventory.
* [kfutil stores inventory show](kfutil_stores_inventory_show.md) - Show the inventory of a certificate store.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_inventory_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ kfutil stores inventory add [flags]

* [kfutil stores inventory](kfutil_stores_inventory.md) - Commands related to certificate store inventory management

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
57 changes: 57 additions & 0 deletions docs/kfutil_stores_inventory_fixrfpkcs12.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## kfutil stores inventory fixrfpkcs12

Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.

### Synopsis

Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.

```
kfutil stores inventory fixrfpkcs12 [flags]
```

### Examples

```
# The below will create a CSV file that can be reviewed and modified before running the command with the --file option.
kfutil stores inventory fixrfpkcs12
# The below will read the CSV file and schedule remove jobs as specified in the file where the 'Action' col is "REMOVE".
# The --force flag is *required* to actually schedule the remove jobs for the certificates.
kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force
```

### Options

```
--file string CSV file to import for RFPKCS12 store fix.
--force Force the removal of the certificate(s) without prompting for confirmation.
-h, --help help for fixrfpkcs12
```

### Options inherited from parent commands

```
--api-path string API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
--auth-provider-profile string The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
--auth-provider-type string Provider type choices: (azid)
--config string Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
--debug Enable debugFlag logging.
--domain string Domain to use for authenticating to Keyfactor Command.
--exp Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
--format text How to format the CLI output. Currently only text is supported. (default "text")
--hostname string Hostname to use for authenticating to Keyfactor Command.
--log-insecure Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--username string Username to use for authenticating to Keyfactor Command.
```

### SEE ALSO

* [kfutil stores inventory](kfutil_stores_inventory.md) - Commands related to certificate store inventory management

###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_inventory_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ kfutil stores inventory remove [flags]

* [kfutil stores inventory](kfutil_stores_inventory.md) - Commands related to certificate store inventory management

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_inventory_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ kfutil stores inventory show [flags]

* [kfutil stores inventory](kfutil_stores_inventory.md) - Commands related to certificate store inventory management

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
2 changes: 1 addition & 1 deletion docs/kfutil_stores_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kfutil stores list [flags]

* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.

###### Auto generated by spf13/cobra on 27-Feb-2024
###### Auto generated by spf13/cobra on 23-Oct-2024
Loading

0 comments on commit e8ccb3a

Please sign in to comment.