Skip to content

Commit 210719a

Browse files
spbsolublespbsoluble
committed
chore(docs): Update stores import csv docs to use product doc verbiage for schedule params.
Signed-off-by: spbsoluble <1661003+spbsoluble@users.noreply.github.com>
1 parent 2b122c9 commit 210719a

File tree

2 files changed

+25
-11
lines changed

2 files changed

+25
-11
lines changed

‎cmd/storesBulkOperations.go

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,19 @@ Required Flags:
132132
| Password | This is equivalent to the 'StorePassword' field in the Command Certificate Store UI. |
133133
134134
###### Inventory Schedule Fields
135+
For full information on certificate store schedules visit: https://software.keyfactor.com/Core-OnPrem/v25.1.1/Content/WebAPI/KeyfactorAPI/CertificateStoresPostSchedule.htm#API-Table-Schedule
136+
137+
> [!NOTE]
138+
> Only one type of schedule can be specified in the CSV file. If multiple are specified,
139+
> the last one will be used. For example you can't schedule both "InventorySchedule.Immediate" and "InventorySchedule.
140+
> Interval.Minutes", in which case the value of "InventorySchedule.Interval.Minutes" would be used.
135141
136142
| Header | Description |
137143
| --- | --- |
138-
| InventorySchedule.Immediate | Boolean value, set to "TRUE" to schedule immediate inventory |
139-
| InventorySchedule.Interval.Minutes | The timeframe in which to periodically inventory int number/integer value. Ex.120 for 2 hours. |
140-
| InventorySchedule.Daily.Time | The time of day to inventory daily, RFC3339 format. Ex. "2023-10-01T12:00:00Z" for noon UTC. |
141-
| InventorySchedule.Weekly.Days | TBD |
144+
| InventorySchedule.Immediate | A Boolean that indicates a job scheduled to run immediately (TRUE) or not (FALSE). |
145+
| InventorySchedule.Interval.Minutes | An integer indicating the number of minutes between each interval. |
146+
| InventorySchedule.Daily.Time | The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format "YYYY-MM-DDTHH:mm:ss.000Z"" (e.g. 2023-11-19T16:23:01Z). |
147+
| InventorySchedule.Weekly.Days | An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (e.g. "Sunday"). |
142148
| InventorySchedule.Weekly.Time | The time of day to inventory daily, RFC3339 format. Ex. "2023-10-01T12:00:00Z" for noon UTC. |
143149
144150
##### Outside CSV file:

‎docs/kfutil_stores_import_csv.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,21 @@ Required Flags:
2525

2626
###### Inventory Schedule Fields
2727

28-
| Header | Description |
29-
|------------------------------------|------------------------------------------------------------------------------------------------|
30-
| InventorySchedule.Immediate | Boolean value, set to "TRUE" to schedule immediate inventory |
31-
| InventorySchedule.Interval.Minutes | The timeframe in which to periodically inventory int number/integer value. Ex.120 for 2 hours. |
32-
| InventorySchedule.Daily.Time | The time of day to inventory daily, RFC3339 format. Ex. "2023-10-01T12:00:00Z" for noon UTC. |
33-
| InventorySchedule.Weekly.Days | TBD |
34-
| InventorySchedule.Weekly.Time | The time of day to inventory daily, RFC3339 format. Ex. "2023-10-01T12:00:00Z" for noon UTC. |
28+
For full information on certificate store schedules
29+
visit: https://software.keyfactor.com/Core-OnPrem/v25.1.1/Content/WebAPI/KeyfactorAPI/CertificateStoresPostSchedule.htm#API-Table-Schedule
30+
31+
> [!NOTE]
32+
> Only one type of schedule can be specified in the CSV file. If multiple are specified,
33+
> the last one will be used. For example you can't schedule both "InventorySchedule.Immediate" and "InventorySchedule.
34+
> Interval.Minutes", in which case the value of "InventorySchedule.Interval.Minutes" would be used.
35+
36+
| Header | Description |
37+
|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
38+
| InventorySchedule.Immediate | A Boolean that indicates a job scheduled to run immediately (TRUE) or not (FALSE). |
39+
| InventorySchedule.Interval.Minutes | An integer indicating the number of minutes between each interval. |
40+
| InventorySchedule.Daily.Time | The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format "YYYY-MM-DDTHH:mm:ss.000Z"" (e.g. 2023-11-19T16:23:01Z). |
41+
| InventorySchedule.Weekly.Days | An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (e.g. "Sunday"). |
42+
| InventorySchedule.Weekly.Time | The time of day to inventory daily, RFC3339 format. Ex. "2023-10-01T12:00:00Z" for noon UTC. |
3543

3644
##### Outside CSV file:
3745
If you do not wish to include credentials in your CSV file they can be provided one of three ways:

0 commit comments

Comments
 (0)