diff --git a/docs/cli/schema.json b/docs/cli/schema.json index 41db13bc..14bb33e8 100644 --- a/docs/cli/schema.json +++ b/docs/cli/schema.json @@ -6,62 +6,12 @@ "cli-schema" ], "globalOptions": [ - { - "role": "flag", - "name": "version", - "type": "boolean", - "required": false, - "shortName": "V", - "summary": "Print the Elastic CLI version" - }, - { - "role": "flag", - "name": "config-file", - "type": "string", - "required": false, - "summary": "path to a config file (default: ~/.elasticrc.yml)" - }, - { - "role": "flag", - "name": "use-context", - "type": "string", - "required": false, - "summary": "override the active context from the config file" - }, - { - "role": "flag", - "name": "command-profile", - "type": "string", - "required": false, - "summary": "restrict available commands to a deployment profile (serverless, stack, default)" - }, { "role": "flag", "name": "json", "type": "boolean", "required": false, "summary": "output as JSON" - }, - { - "role": "flag", - "name": "output-fields", - "type": "string", - "required": false, - "summary": "comma-separated list of fields to include in output (dot-notation supported)" - }, - { - "role": "flag", - "name": "output-template", - "type": "string", - "required": false, - "summary": "Mustache-like template for custom text output (e.g. \"{{id}}: {{name}}\")" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" } ], "environment": { @@ -109,7 +59,15 @@ { "path": [], "name": "version", - "parameters": [], + "parameters": [ + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Print the elastic CLI version", "intent": { "requiresAuth": false @@ -231,6 +189,20 @@ "name": "operations", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk index or delete documents.", @@ -335,6 +307,20 @@ "name": "document", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a new document in the index.", @@ -422,6 +408,20 @@ "type": "number", "required": false, "summary": "The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a document.", @@ -667,6 +667,20 @@ "summary": "A sort object that specifies the order of deleted documents.", "repeatable": true, "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete documents.", @@ -769,6 +783,20 @@ "type": "string", "required": false, "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check a document.", @@ -866,6 +894,20 @@ "type": "string", "required": false, "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check for a document source.", @@ -978,6 +1020,20 @@ "type": "string", "required": false, "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a document by its ID.", @@ -1075,6 +1131,20 @@ "type": "string", "required": false, "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a document's source.", @@ -1203,6 +1273,20 @@ "name": "document", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a document in an index.", @@ -1303,6 +1387,20 @@ "summary": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "repeatable": true, "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get multiple documents.", @@ -1410,6 +1508,20 @@ "type": "string", "required": true, "summary": "The source you are copying from." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reindex documents.", @@ -1575,6 +1687,20 @@ "type": "string", "required": false, "summary": "If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a document.", @@ -1836,6 +1962,20 @@ "type": "string", "required": false, "summary": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update documents.", @@ -1858,6 +1998,20 @@ "summary": "The scroll IDs to clear. To clear all scroll IDs, use `_all`.", "repeatable": true, "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear a scrolling search.", @@ -1881,6 +2035,20 @@ "type": "string", "required": true, "summary": "The ID of the point-in-time." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Close a point in time.", @@ -2004,6 +2172,20 @@ "name": "searches", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run multiple searches.", @@ -2069,6 +2251,20 @@ "name": "search-templates", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run multiple templated searches.", @@ -2151,6 +2347,20 @@ "type": "string", "required": false, "summary": "Filter indices if the provided query rewrites to `match_none` on every shard." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Open a point in time.", @@ -2191,6 +2401,20 @@ "type": "string", "required": false, "summary": "An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Render a search template.", @@ -2228,6 +2452,20 @@ "type": "string", "required": true, "summary": "The scroll ID of the search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a scrolling search.", @@ -2714,6 +2952,20 @@ "type": "array", "required": false, "summary": "The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a search.", @@ -2868,6 +3120,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Search a vector tile.", @@ -2940,6 +3206,20 @@ "required": false, "summary": "A custom value used to route operations to a specific shard.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the search shards.", @@ -3078,6 +3358,20 @@ "type": "string", "required": false, "summary": "An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a search with a search template.", @@ -3209,6 +3503,20 @@ "type": "string", "required": false, "summary": "Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Count search results.", @@ -3332,6 +3640,20 @@ "type": "string", "required": false, "summary": "Defines the search definition using the Query DSL." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Explain a document match result.", @@ -3430,6 +3752,20 @@ "type": "string", "required": false, "summary": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the field capabilities.", @@ -3546,6 +3882,20 @@ "type": "array", "required": false, "summary": "A simplified syntax to specify documents by their ID if they're in the same index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get multiple term vectors.", @@ -3613,6 +3963,20 @@ "type": "string", "required": false, "summary": "Definition of the evaluation metric to calculate." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Evaluate ranked search results.", @@ -3686,6 +4050,20 @@ "type": "string", "required": false, "summary": "The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get terms in an index.", @@ -3816,6 +4194,20 @@ "type": "string", "required": false, "summary": "The version type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get term vector information.", @@ -3853,6 +4245,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a script or search template.", @@ -3883,6 +4289,20 @@ "type": "string", "required": false, "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a script or search template.", @@ -3899,7 +4319,22 @@ "es" ], "name": "get-script-context", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get script contexts.", "intent": { "destructive": false, @@ -3914,7 +4349,22 @@ "es" ], "name": "get-script-languages", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get script languages.", "intent": { "destructive": false, @@ -3964,6 +4414,20 @@ "type": "string", "required": true, "summary": "The script or search template, its parameters, and its language." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a script or search template.", @@ -4001,6 +4465,20 @@ "type": "string", "required": false, "summary": "The Painless script to run." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a script.", @@ -4046,6 +4524,20 @@ "type": "number", "required": false, "summary": "Limit the number of affected resources the health report API returns." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the cluster health.", @@ -4062,7 +4554,22 @@ "es" ], "name": "info", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get cluster info.", "intent": { "destructive": false, @@ -4077,7 +4584,22 @@ "es" ], "name": "ping", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Ping the cluster.", "intent": { "destructive": false, @@ -4106,6 +4628,20 @@ "type": "number", "required": true, "summary": "The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Throttle a delete by query operation.", @@ -4133,6 +4669,20 @@ "type": "number", "required": true, "summary": "The throttle for this request in sub-requests per second. It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Throttle a reindex operation.", @@ -4160,12 +4710,38 @@ "type": "number", "required": true, "summary": "The throttle for this request in sub-requests per second. To turn off throttling, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Throttle an update by query operation.", "intent": { "requiresAuth": true } + }, + { + "path": [ + "stack", + "es" + ], + "name": "helpers", + "parameters": [], + "summary": "High-level helper commands for common Elasticsearch workflows", + "intent": { + "requiresAuth": true + } } ], "namespaces": [ @@ -4186,6 +4762,20 @@ "type": "string", "required": true, "summary": "A unique identifier for the async search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an async search.", @@ -4238,6 +4828,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get async search results.", @@ -4269,6 +4873,20 @@ "type": "string", "required": false, "summary": "The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the async search status.", @@ -4731,6 +5349,20 @@ "type": "array", "required": false, "summary": "Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run an async search.", @@ -4791,6 +5423,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get aliases.", @@ -4846,6 +5492,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get shard allocation information.", @@ -4901,6 +5561,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get circuit breakers statistics.", @@ -4955,6 +5629,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get component templates.", @@ -4996,6 +5684,20 @@ "required": false, "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a document count.", @@ -5034,6 +5736,20 @@ "required": false, "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get field data cache information.", @@ -5074,6 +5790,20 @@ "required": false, "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the cluster health status.", @@ -5091,7 +5821,22 @@ "cat" ], "name": "help", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get CAT help.", "intent": { "destructive": false, @@ -5167,6 +5912,20 @@ "required": false, "summary": "List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index information.", @@ -5214,6 +5973,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get master node information.", @@ -5261,6 +6034,20 @@ "required": false, "summary": "Comma-separated list of column names or column aliases used to sort the response.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data frame analytics jobs.", @@ -5308,6 +6095,20 @@ "required": false, "summary": "Comma-separated list of column names or column aliases used to sort the response.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get datafeeds.", @@ -5355,6 +6156,20 @@ "required": false, "summary": "Comma-separated list of column names or column aliases used to sort the response.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection jobs.", @@ -5416,6 +6231,20 @@ "type": "number", "required": false, "summary": "The maximum number of transforms to display." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get trained models.", @@ -5463,6 +6292,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get node attribute information.", @@ -5517,6 +6360,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get node information.", @@ -5564,6 +6421,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get pending task information.", @@ -5618,6 +6489,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get plugin information.", @@ -5673,6 +6558,20 @@ "required": false, "summary": "A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get shard recovery information.", @@ -5720,6 +6619,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get snapshot repository information.", @@ -5811,6 +6724,20 @@ "type": "boolean", "required": false, "summary": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get segment information.", @@ -5859,6 +6786,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get shard information.", @@ -5914,6 +6855,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get snapshot information.", @@ -5989,6 +6944,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request blocks until the task has completed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get task information.", @@ -6043,6 +7012,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index template information.", @@ -6098,6 +7081,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get thread pool statistics.", @@ -6159,6 +7156,20 @@ "type": "number", "required": false, "summary": "The maximum number of transforms to obtain." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get transform information.", @@ -6197,6 +7208,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete auto-follow patterns.", @@ -6333,6 +7358,20 @@ "type": "string", "required": false, "summary": "Settings to override from the leader index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a follower.", @@ -6365,6 +7404,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get follower information.", @@ -6397,6 +7450,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get follower stats.", @@ -6452,6 +7519,20 @@ "name": "leader-remote-cluster", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Forget a follower.", @@ -6480,6 +7561,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get auto-follow patterns.", @@ -6511,6 +7606,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Pause an auto-follow pattern.", @@ -6539,6 +7648,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Pause a follower.", @@ -6672,6 +7795,20 @@ "type": "number", "required": false, "summary": "The maximum total bytes of operations per bulk write request executed on the follower." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update auto-follow patterns.", @@ -6703,6 +7840,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume an auto-follow pattern.", @@ -6791,6 +7942,20 @@ "name": "read-poll-timeout", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume a follower.", @@ -6819,6 +7984,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cross-cluster replication stats.", @@ -6850,6 +8029,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unfollow an index.", @@ -6920,6 +8113,20 @@ "type": "string", "required": false, "summary": "Explain a shard only if it is currently located on the specified node name or node ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Explain the shard allocations.", @@ -6959,6 +8166,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete component templates.", @@ -6990,6 +8211,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear cluster voting config exclusions.", @@ -7029,6 +8264,20 @@ "type": "boolean", "required": false, "summary": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check component templates.", @@ -7089,6 +8338,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get component templates.", @@ -7134,6 +8397,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cluster-wide settings.", @@ -7237,6 +8514,20 @@ "type": "string", "required": false, "summary": "Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status). A green status is better than yellow and yellow is better than red. By default, the request does not wait for a particular status." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the cluster health status.", @@ -7269,6 +8560,20 @@ "thread_pool", "script" ] + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cluster info.", @@ -7300,6 +8605,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the pending cluster tasks.", @@ -7347,6 +8666,20 @@ "type": "string", "required": false, "summary": "When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update voting configuration exclusions.", @@ -7417,6 +8750,20 @@ "type": "boolean", "required": false, "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a component template.", @@ -7469,6 +8816,20 @@ "type": "string", "required": false, "summary": "The settings that do not persist after the cluster restarts." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the cluster settings.", @@ -7486,7 +8847,22 @@ "cluster" ], "name": "remote-info", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get remote cluster information.", "intent": { "destructive": false, @@ -7503,6 +8879,13 @@ ], "name": "reroute", "parameters": [ + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes." + }, { "role": "flag", "name": "explain", @@ -7545,6 +8928,13 @@ "type": "array", "required": false, "summary": "Defines the commands to perform." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Reroute the cluster.", @@ -7632,6 +9022,20 @@ "type": "string", "required": false, "summary": "The maximum time to wait for wait_for_metadata_version before timing out" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the cluster state.", @@ -7649,7 +9053,22 @@ "cluster" ], "name": "stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get cluster statistics.", "intent": { "destructive": false, @@ -7679,6 +9098,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector to be checked in" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check in a connector.", @@ -7717,6 +9150,20 @@ "type": "boolean", "required": false, "summary": "A flag indicating if the connector should be hard deleted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a connector.", @@ -7748,6 +9195,20 @@ "type": "boolean", "required": false, "summary": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a connector.", @@ -7817,6 +9278,20 @@ "type": "string", "required": false, "summary": "A wildcard query string that filters connectors with matching name, description or index name" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all connectors.", @@ -7870,6 +9345,20 @@ "name": "service-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a connector.", @@ -7927,6 +9416,20 @@ "name": "service-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a connector.", @@ -7951,6 +9454,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector sync job" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel a connector sync job.", @@ -7975,6 +9492,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector sync job to be checked in." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check in a connector sync job.", @@ -8013,6 +9544,20 @@ "type": "string", "required": true, "summary": "The host name of the current system that will run the job." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Claim a connector sync job.", @@ -8037,6 +9582,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector sync job to be deleted" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a connector sync job.", @@ -8068,6 +9627,20 @@ "type": "string", "required": true, "summary": "The error for the connector sync job error field." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set a connector sync job error.", @@ -8092,6 +9665,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector sync job" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a connector sync job.", @@ -8145,6 +9732,20 @@ "required": false, "summary": "A comma-separated list of job types to fetch the sync jobs for", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all connector sync jobs.", @@ -8181,6 +9782,20 @@ "name": "trigger-method", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a connector sync job.", @@ -8244,6 +9859,20 @@ "type": "number", "required": false, "summary": "The total number of documents in the target index after the sync job finished." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set the connector sync job stats.", @@ -8268,6 +9897,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the connector to be updated" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Activate the connector draft filter.", @@ -8304,6 +9947,20 @@ "name": "api-key-secret-id", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector API key ID.", @@ -8340,6 +9997,20 @@ "name": "values", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector configuration.", @@ -8370,6 +10041,20 @@ "name": "error", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector error field.", @@ -8400,6 +10085,20 @@ "name": "features", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector features.", @@ -8442,6 +10141,20 @@ "name": "advanced-snippet", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector filtering.", @@ -8472,6 +10185,20 @@ "name": "validation", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector draft filtering validation.", @@ -8502,6 +10229,20 @@ "name": "index-name", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector index name.", @@ -8538,6 +10279,20 @@ "name": "description", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector name and description.", @@ -8568,6 +10323,20 @@ "name": "is-native", "type": "boolean", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector is_native flag.", @@ -8598,6 +10367,20 @@ "name": "pipeline", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector pipeline.", @@ -8628,6 +10411,20 @@ "name": "scheduling", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector scheduling.", @@ -8658,6 +10455,20 @@ "name": "service-type", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector service type.", @@ -8688,6 +10499,20 @@ "name": "status", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the connector status.", @@ -8740,6 +10565,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a dangling index.", @@ -8785,6 +10624,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import a dangling index.", @@ -8799,7 +10652,22 @@ "dangling-indices" ], "name": "list-dangling-indices", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the dangling indices.", "intent": { "destructive": false, @@ -8836,6 +10704,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an enrich policy.", @@ -8874,6 +10756,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request blocks other enrich policy execution requests until complete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run an enrich policy.", @@ -8906,6 +10802,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an enrich policy.", @@ -8958,6 +10868,20 @@ "type": "string", "required": false, "summary": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an enrich policy.", @@ -8982,6 +10906,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get enrich stats.", @@ -9013,6 +10951,20 @@ "type": "string", "required": true, "summary": "Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided if the request’s `keep_on_completion` parameter is `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an async EQL search.", @@ -9051,6 +11003,20 @@ "type": "string", "required": false, "summary": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get async EQL search results.", @@ -9075,6 +11041,20 @@ "type": "string", "required": true, "summary": "Identifier for the search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the async EQL status.", @@ -9246,6 +11226,20 @@ "type": "number", "required": false, "summary": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the `max_samples_per_key` parameter. Pipes are not supported for sample queries." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get EQL search results.", @@ -9389,6 +11383,20 @@ "type": "boolean", "required": false, "summary": "Indicates whether the query and its results are stored in the cluster. If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run an async ES|QL query.", @@ -9410,6 +11418,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an async ES|QL query.", @@ -9462,6 +11484,20 @@ "type": "string", "required": false, "summary": "The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an `is_running` value of `true` and no results." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get async ES|QL query results.", @@ -9493,6 +11529,20 @@ "type": "boolean", "required": false, "summary": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop async ES|QL query.", @@ -9515,6 +11565,20 @@ "required": true, "summary": "The view name to remove.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an ES|QL view.", @@ -9539,6 +11603,20 @@ "type": "string", "required": true, "summary": "The query ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a specific running ES|QL query information.", @@ -9563,6 +11641,20 @@ "type": "string", "required": false, "summary": "The comma-separated view names to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an ES|QL view.", @@ -9580,7 +11672,22 @@ "esql" ], "name": "list-queries", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get running ES|QL queries information.", "intent": { "destructive": false, @@ -9610,6 +11717,20 @@ "type": "string", "required": true, "summary": "The ES|QL query string from which to create a view." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update an ES|QL view.", @@ -9725,6 +11846,20 @@ "type": "boolean", "required": false, "summary": "When set to `true`, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run an ES|QL query.", @@ -9753,6 +11888,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the features.", @@ -9777,6 +11926,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset the features.", @@ -9833,6 +11996,20 @@ "type": "string", "required": false, "summary": "Period to wait for a global checkpoints to advance past `checkpoints`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get global checkpoints.", @@ -9955,6 +12132,20 @@ "name": "searches", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run multiple Fleet searches.", @@ -10384,6 +12575,20 @@ "type": "array", "required": false, "summary": "Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a Fleet search.", @@ -10459,6 +12664,20 @@ "type": "array", "required": false, "summary": "Specifies one or more fields that contain the terms you want to include in the graph as vertices." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Explore graph analytics.", @@ -10483,7 +12702,22 @@ "ilm" ], "name": "delete-lifecycle", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete a lifecycle policy.", "intent": { "destructive": true, @@ -10527,6 +12761,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Explain the lifecycle state.", @@ -10544,7 +12792,22 @@ "ilm" ], "name": "get-lifecycle", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get lifecycle policies.", "intent": { "destructive": false, @@ -10560,7 +12823,22 @@ "ilm" ], "name": "get-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the ILM status.", "intent": { "destructive": false, @@ -10577,6 +12855,13 @@ ], "name": "migrate-to-data-tiers", "parameters": [ + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated." + }, { "role": "flag", "name": "master-timeout", @@ -10595,6 +12880,13 @@ "name": "node-attribute", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Migrate to data tiers routing.", @@ -10630,6 +12922,20 @@ "type": "string", "required": true, "summary": "The step that you want to run." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Move to a lifecycle step.", @@ -10644,7 +12950,22 @@ "ilm" ], "name": "put-lifecycle", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create or update a lifecycle policy.", "intent": { "destructive": false, @@ -10667,6 +12988,20 @@ "type": "string", "required": true, "summary": "The name of the index to remove policy on" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Remove policies from an index.", @@ -10688,6 +13023,20 @@ "type": "string", "required": true, "summary": "The name of the indices (comma-separated) whose failed lifecycle step is to be retry" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Retry a policy.", @@ -10716,6 +13065,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start the ILM plugin.", @@ -10744,6 +13107,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop the ILM plugin.", @@ -10822,6 +13199,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add an index block.", @@ -10911,6 +13302,20 @@ "type": "string", "required": false, "summary": "Tokenizer to use to convert text into tokens." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get tokens from text analysis.", @@ -10936,6 +13341,20 @@ "required": true, "summary": "The index or data stream name", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel a migration reindex operation.", @@ -11009,6 +13428,20 @@ "type": "boolean", "required": false, "summary": "If `true`, clears the request cache." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the cache.", @@ -11072,6 +13505,20 @@ "type": "string", "required": false, "summary": "Configuration options for the target index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clone an index.", @@ -11140,6 +13587,20 @@ "type": "number", "required": false, "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Close an index.", @@ -11203,6 +13664,20 @@ "type": "string", "required": false, "summary": "Configuration options for the index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an index.", @@ -11241,6 +13716,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a data stream.", @@ -11278,6 +13767,20 @@ "name": "create-from", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an index from a source index.", @@ -11311,6 +13814,20 @@ "required": false, "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data stream stats.", @@ -11372,6 +13889,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete indices.", @@ -11419,6 +13950,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an alias.", @@ -11466,6 +14011,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete data stream lifecycles.", @@ -11506,6 +14065,20 @@ "required": false, "summary": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete data streams.", @@ -11553,6 +14126,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete data stream options.", @@ -11592,6 +14179,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an index template.", @@ -11630,6 +14231,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a legacy index template.", @@ -11691,6 +14306,20 @@ "type": "boolean", "required": false, "summary": "Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Analyze the index disk usage.", @@ -11725,6 +14354,20 @@ "name": "config", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Downsample an index.", @@ -11790,6 +14433,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request retrieves information from the local node only." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check indices.", @@ -11852,6 +14509,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check aliases.", @@ -11897,6 +14568,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check index templates.", @@ -11943,6 +14628,20 @@ "type": "string", "required": false, "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check existence of index templates.", @@ -11982,6 +14681,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status for a data stream lifecycle.", @@ -12037,6 +14750,20 @@ "required": false, "summary": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get field usage stats.", @@ -12098,6 +14825,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Flush data streams or indices.", @@ -12170,6 +14911,20 @@ "type": "boolean", "required": false, "summary": "Should the request wait until the force merge is completed" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Force a merge.", @@ -12250,6 +15005,20 @@ "required": false, "summary": "Return only information on specified index features", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index information.", @@ -12312,6 +15081,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get aliases.", @@ -12359,6 +15142,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data stream lifecycles.", @@ -12376,7 +15173,22 @@ "indices" ], "name": "get-data-lifecycle-stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get data stream lifecycle stats.", "intent": { "destructive": false, @@ -12429,6 +15241,20 @@ "type": "boolean", "required": false, "summary": "Whether the maximum timestamp for each data stream should be calculated and returned." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data streams.", @@ -12461,6 +15287,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data stream mappings.", @@ -12501,6 +15341,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data stream options.", @@ -12533,6 +15387,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data stream settings.", @@ -12595,6 +15463,20 @@ "type": "boolean", "required": false, "summary": "If `true`, return all default settings in the response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get mapping definitions.", @@ -12647,6 +15529,20 @@ "type": "boolean", "required": false, "summary": "If true, returns all relevant default configurations for the index template." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index templates.", @@ -12708,6 +15604,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get mapping definitions.", @@ -12733,6 +15643,20 @@ "required": true, "summary": "The index or data stream name.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the migration reindexing status.", @@ -12816,6 +15740,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index settings.", @@ -12862,6 +15800,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get legacy index templates.", @@ -12885,6 +15837,20 @@ "name": "reindex", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reindex legacy backing indices.", @@ -12920,6 +15886,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Convert an index alias to a data stream.", @@ -12941,6 +15921,20 @@ "type": "array", "required": true, "summary": "Actions to perform." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update data streams.", @@ -13006,6 +16000,20 @@ "type": "number", "required": false, "summary": "The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Open a closed index.", @@ -13034,6 +16042,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Promote a data stream.", @@ -13112,6 +16134,20 @@ "type": "string", "required": false, "summary": "Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update an alias.", @@ -13187,6 +16223,20 @@ "type": "boolean", "required": false, "summary": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update data stream lifecycles.", @@ -13213,6 +16263,13 @@ "summary": "A comma-separated list of data streams or data stream patterns.", "repeatable": true }, + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "If `true`, the request does not actually change the mappings on any data streams. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied." + }, { "role": "flag", "name": "master-timeout", @@ -13232,6 +16289,13 @@ "name": "mappings", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Update data stream mappings.", @@ -13286,6 +16350,20 @@ "type": "string", "required": false, "summary": "If defined, it will update the failure store configuration of every data stream resolved by the name expression." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update data stream options.", @@ -13312,6 +16390,13 @@ "summary": "A comma-separated list of data streams or data stream patterns.", "repeatable": true }, + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied." + }, { "role": "flag", "name": "master-timeout", @@ -13331,6 +16416,13 @@ "name": "settings", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Update data stream settings.", @@ -13448,6 +16540,20 @@ "type": "boolean", "required": false, "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update an index template.", @@ -13593,6 +16699,20 @@ "type": "string", "required": false, "summary": "Mapping of runtime fields for the index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update field mappings.", @@ -13681,6 +16801,20 @@ "name": "settings", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update index settings.", @@ -13770,6 +16904,20 @@ "type": "number", "required": false, "summary": "Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. To unset a version, replace the template without specifying one." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a legacy index template.", @@ -13831,6 +16979,20 @@ "type": "boolean", "required": false, "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index recovery information.", @@ -13878,6 +17040,20 @@ "type": "boolean", "required": false, "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Refresh an index.", @@ -13929,6 +17105,20 @@ "type": "string", "required": false, "summary": "Changed resource to reload analyzers from if applicable" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reload search analyzers.", @@ -14003,6 +17193,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Remove an index block.", @@ -14064,6 +17268,20 @@ "type": "string", "required": false, "summary": "The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resolve the cluster.", @@ -14119,6 +17337,20 @@ "required": false, "summary": "Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resolve indices.", @@ -14151,6 +17383,13 @@ "required": false, "summary": "Name of the index to create. Supports date math. Data streams do not support this parameter." }, + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover." + }, { "role": "flag", "name": "master-timeout", @@ -14206,6 +17445,13 @@ "type": "string", "required": false, "summary": "Configuration options for the index. Data streams do not support this parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Roll over to a new index.", @@ -14250,6 +17496,20 @@ "type": "boolean", "required": false, "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index segments.", @@ -14305,6 +17565,20 @@ "required": false, "summary": "List of shard health statuses used to limit the request.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index shard stores.", @@ -14371,6 +17645,20 @@ "type": "string", "required": false, "summary": "Configuration options for the target index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Shrink an index.", @@ -14429,6 +17717,20 @@ "name": "index-template", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Simulate an index.", @@ -14550,6 +17852,20 @@ "type": "boolean", "required": false, "summary": "Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Simulate an index template.", @@ -14613,6 +17929,20 @@ "type": "string", "required": false, "summary": "Configuration options for the target index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Split an index.", @@ -14714,6 +18044,20 @@ "type": "string", "required": false, "summary": "Indicates whether statistics are aggregated at the cluster, indices, or shards level." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get index statistics.", @@ -14752,6 +18096,20 @@ "type": "array", "required": false, "summary": "Actions to perform." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update an alias.", @@ -14866,6 +18224,20 @@ "type": "string", "required": false, "summary": "Query in the Lucene query string syntax." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Validate a query.", @@ -14910,6 +18282,20 @@ "name": "chat-completion-request", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform chat completion inference on the service.", @@ -14954,6 +18340,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform completion inference on the service.", @@ -14983,12 +18383,26 @@ "required": true, "summary": "The inference identifier." }, + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint." + }, { "role": "flag", "name": "force", "type": "boolean", "required": false, "summary": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Delete an inference endpoint.", @@ -15026,6 +18440,20 @@ "name": "embedding", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform dense embedding inference on the service.", @@ -15054,6 +18482,20 @@ "type": "string", "required": false, "summary": "The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified `task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an inference endpoint.", @@ -15122,6 +18564,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform inference on the service.", @@ -15163,6 +18619,20 @@ "name": "inference-config", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an inference endpoint.", @@ -15222,6 +18692,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `ai21` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a AI21 inference endpoint.", @@ -15297,6 +18781,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an AlibabaCloud AI Search inference endpoint.", @@ -15371,6 +18869,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Amazon Bedrock inference endpoint.", @@ -15447,6 +18959,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type and `service_settings.api` you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Amazon SageMaker inference endpoint.", @@ -15512,6 +19038,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Anthropic inference endpoint.", @@ -15586,6 +19126,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Azure AI studio inference endpoint.", @@ -15660,6 +19214,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Azure OpenAI inference endpoint.", @@ -15734,6 +19302,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Cohere inference endpoint.", @@ -15799,6 +19381,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Contextual AI inference endpoint.", @@ -15867,6 +19463,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a custom inference endpoint.", @@ -15926,6 +19536,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `deepseek` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a DeepSeek inference endpoint.", @@ -16000,6 +19624,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Elasticsearch inference endpoint.", @@ -16065,6 +19703,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `elser` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an ELSER inference endpoint.", @@ -16139,6 +19791,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. Applies only to the `completion` or `chat_completion` task types. Not applicable to the `text_embedding` task type. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Fireworks AI inference endpoint.", @@ -16205,6 +19871,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Google AI Studio inference endpoint.", @@ -16280,6 +19960,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Google Vertex AI inference endpoint.", @@ -16338,6 +20032,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `groq` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Groq inference endpoint.", @@ -16413,6 +20121,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Hugging Face inference endpoint.", @@ -16487,6 +20209,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an JinaAI inference endpoint.", @@ -16554,6 +20290,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `llama` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Llama inference endpoint.", @@ -16621,6 +20371,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `mistral` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Mistral inference endpoint.", @@ -16696,6 +20460,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion`, or `chat_completion` task types. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Nvidia inference endpoint.", @@ -16771,6 +20549,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an OpenAI inference endpoint.", @@ -16846,6 +20638,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. Applies only to the `rerank` task type. Not applicable to the `text_embedding`, `completion`, or `chat_completion` task types. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an OpenShift AI inference endpoint.", @@ -16919,6 +20725,20 @@ "type": "string", "required": false, "summary": "Settings to configure the inference task. These settings are specific to the task type you specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a VoyageAI inference endpoint.", @@ -16987,6 +20807,20 @@ "type": "string", "required": true, "summary": "Settings used to install the inference model. These settings are specific to the `watsonxai` service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Watsonx inference endpoint.", @@ -17054,6 +20888,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform reranking inference on the service.", @@ -17098,6 +20946,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform sparse embedding inference on the service.", @@ -17142,6 +21004,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform streaming completion inference on the service.", @@ -17193,6 +21069,20 @@ "type": "string", "required": false, "summary": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Perform text embedding inference on the service.", @@ -17227,6 +21117,20 @@ "name": "inference-config", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an inference endpoint.", @@ -17273,6 +21177,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete GeoIP database configurations.", @@ -17312,6 +21230,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete IP geolocation database configurations.", @@ -17350,6 +21282,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete pipelines.", @@ -17367,7 +21313,22 @@ "ingest" ], "name": "geo-ip-stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get GeoIP statistics.", "intent": { "destructive": false, @@ -17391,6 +21352,20 @@ "required": false, "summary": "A comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get GeoIP database configurations.", @@ -17416,6 +21391,20 @@ "required": false, "summary": "Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get IP geolocation database configurations.", @@ -17454,6 +21443,20 @@ "type": "boolean", "required": false, "summary": "Return pipelines without their definitions" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get pipelines.", @@ -17471,7 +21474,22 @@ "ingest" ], "name": "processor-grok", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Run a grok processor.", "intent": { "destructive": false, @@ -17522,6 +21540,20 @@ "type": "string", "required": true, "summary": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a GeoIP database configuration.", @@ -17566,6 +21598,20 @@ "name": "configuration", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update an IP geolocation database configuration.", @@ -17660,6 +21706,20 @@ "type": "string", "required": false, "summary": "Controls how processors in this pipeline should read and write data on a document's source." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a pipeline.", @@ -17705,6 +21765,20 @@ "type": "string", "required": false, "summary": "The pipeline to test. If you don't specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Simulate a pipeline.", @@ -17743,6 +21817,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete the license.", @@ -17774,6 +21862,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether to retrieve local information. From 9.2 onwards the default value is `true`, which means the information is retrieved from the responding node. In earlier versions the default is `false`, which means the information is retrieved from the elected master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get license information.", @@ -17791,7 +21893,22 @@ "license" ], "name": "get-basic-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the basic license status.", "intent": { "destructive": false, @@ -17807,7 +21924,22 @@ "license" ], "name": "get-trial-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the trial status.", "intent": { "destructive": false, @@ -17857,6 +21989,20 @@ "type": "array", "required": false, "summary": "A sequence of one or more JSON documents containing the license information." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the license.", @@ -17895,6 +22041,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start a basic license.", @@ -17930,6 +22090,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start a trial.", @@ -17958,6 +22132,20 @@ "type": "string", "required": true, "summary": "An identifier for the pipeline." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a Logstash pipeline.", @@ -17983,6 +22171,20 @@ "required": false, "summary": "A comma-separated list of pipeline identifiers.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Logstash pipelines.", @@ -18013,6 +22215,20 @@ "name": "pipeline", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a Logstash pipeline.", @@ -18044,6 +22260,20 @@ "type": "string", "required": false, "summary": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get deprecation information.", @@ -18061,7 +22291,22 @@ "migration" ], "name": "get-feature-upgrade-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get feature migration information.", "intent": { "destructive": false, @@ -18077,7 +22322,22 @@ "migration" ], "name": "post-feature-upgrade", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Start the feature migration.", "intent": { "requiresAuth": true @@ -18104,6 +22364,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the trained model." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear trained model deployment cache.", @@ -18146,6 +22420,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `timeout` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Close anomaly detection jobs.", @@ -18167,6 +22455,20 @@ "type": "string", "required": true, "summary": "A string that uniquely identifies a calendar." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a calendar.", @@ -18198,6 +22500,20 @@ "type": "string", "required": true, "summary": "Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete events from a calendar.", @@ -18230,6 +22546,20 @@ "required": true, "summary": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete anomaly jobs from a calendar.", @@ -18268,6 +22598,20 @@ "type": "string", "required": false, "summary": "The time to wait for the job to be deleted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a data frame analytics job.", @@ -18299,6 +22643,20 @@ "type": "boolean", "required": false, "summary": "Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a datafeed.", @@ -18337,6 +22695,20 @@ "type": "string", "required": false, "summary": "How long can the underlying delete processes run until they are canceled." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete expired ML data.", @@ -18361,6 +22733,20 @@ "type": "string", "required": true, "summary": "A string that uniquely identifies a filter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a filter.", @@ -18406,6 +22792,20 @@ "type": "string", "required": false, "summary": "Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete forecasts from a job.", @@ -18451,6 +22851,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether the request should return immediately or wait until the job deletion completes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an anomaly detection job.", @@ -18482,6 +22896,20 @@ "type": "string", "required": true, "summary": "Identifier for the model snapshot." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a model snapshot.", @@ -18520,6 +22948,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an unreferenced trained model.", @@ -18551,6 +22993,20 @@ "type": "string", "required": true, "summary": "The trained model ID to which the model alias refers." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a trained model alias.", @@ -18589,6 +23045,20 @@ "type": "string", "required": false, "summary": "Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in the `by_field_name`, `over_field_name` and `partition_field_name` of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have a `by_field_name`, `over_field_name` or `partition_field_name`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Estimate job model memory usage.", @@ -18624,6 +23094,20 @@ "type": "string", "required": false, "summary": "A query clause that retrieves a subset of data from the source index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Evaluate data frame analytics.", @@ -18703,6 +23187,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Explain data frame analytics config.", @@ -18762,6 +23260,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `start` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Force buffered data to be processed.", @@ -18804,6 +23316,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `max_model_memory` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Predict future behavior of a time series.", @@ -18901,6 +23427,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `start` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection job results for buckets.", @@ -18960,6 +23500,20 @@ "type": "string", "required": false, "summary": "Specifies to get events with timestamps after this time." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get info about events in calendars.", @@ -19005,6 +23559,20 @@ "type": "string", "required": false, "summary": "This object is supported only when you omit the calendar identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get calendar configuration info.", @@ -19064,6 +23632,20 @@ "type": "string", "required": false, "summary": "Configures pagination. This parameter has the `from` and `size` properties." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection job results for categories.", @@ -19116,6 +23698,20 @@ "type": "boolean", "required": false, "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data frame analytics job configuration info.", @@ -19168,6 +23764,20 @@ "type": "boolean", "required": false, "summary": "Defines whether the stats response should be verbose." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data frame analytics job stats.", @@ -19200,6 +23810,20 @@ "type": "boolean", "required": false, "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get datafeed stats.", @@ -19239,6 +23863,20 @@ "type": "boolean", "required": false, "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get datafeeds configuration info.", @@ -19278,6 +23916,20 @@ "type": "number", "required": false, "summary": "Specifies the maximum number of filters to obtain." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get filters.", @@ -19365,6 +24017,20 @@ "type": "string", "required": false, "summary": "Configures pagination. This parameter has the `from` and `size` properties." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection job results for influencers.", @@ -19396,6 +24062,20 @@ "type": "boolean", "required": false, "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a `404` status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection job stats.", @@ -19435,6 +24115,20 @@ "type": "boolean", "required": false, "summary": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection jobs configuration info.", @@ -19473,6 +24167,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get machine learning memory usage info.", @@ -19511,6 +24219,20 @@ "type": "boolean", "required": false, "summary": "Specifies what to do when the request: - Contains wildcard expressions and there are no jobs that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly detection job model snapshot upgrade usage info.", @@ -19590,6 +24312,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `start` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get model snapshots info.", @@ -19663,6 +24399,20 @@ "type": "number", "required": false, "summary": "Refer to the description for the `top_n` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get overall bucket results.", @@ -19749,6 +24499,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `start` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anomaly records for an anomaly detection job.", @@ -19824,6 +24588,20 @@ "required": false, "summary": "A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get trained model configuration info.", @@ -19870,6 +24648,20 @@ "type": "number", "required": false, "summary": "Specifies the maximum number of models to obtain." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get trained models usage info.", @@ -19915,6 +24707,20 @@ "type": "string", "required": false, "summary": "The inference configuration updates to apply on the API call" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Evaluate a trained model.", @@ -19929,7 +24735,22 @@ "ml" ], "name": "info", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get machine learning information.", "intent": { "destructive": false, @@ -19959,6 +24780,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `timeout` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Open anomaly detection jobs.", @@ -19987,6 +24822,20 @@ "type": "array", "required": true, "summary": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add scheduled events to the calendar.", @@ -20028,6 +24877,20 @@ "name": "data", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Send data to an anomaly detection job for analysis.", @@ -20056,6 +24919,20 @@ "type": "string", "required": false, "summary": "A data frame analytics config as described in create data frame analytics jobs. Note that `id` and `dest` don’t need to be provided in the context of this API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview features used by data frame analytics.", @@ -20108,6 +24985,20 @@ "type": "string", "required": false, "summary": "The configuration details for the anomaly detection job that is associated with the datafeed. If the `datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must supply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is used. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview a datafeed.", @@ -20146,6 +25037,20 @@ "type": "string", "required": false, "summary": "A description of the calendar." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a calendar.", @@ -20178,6 +25083,20 @@ "required": true, "summary": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add anomaly detection job to calendar.", @@ -20278,6 +25197,20 @@ "name": "version", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a data frame analytics job.", @@ -20445,6 +25378,20 @@ "name": "headers", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a datafeed.", @@ -20483,6 +25430,20 @@ "type": "array", "required": false, "summary": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a filter.", @@ -20641,6 +25602,20 @@ "type": "number", "required": false, "summary": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an anomaly detection job.", @@ -20756,6 +25731,20 @@ "type": "string", "required": false, "summary": "Optional prefix strings applied at inference" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a trained model.", @@ -20794,6 +25783,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a trained model alias.", @@ -20846,6 +25849,20 @@ "type": "number", "required": true, "summary": "The total number of parts that will be uploaded. Must be greater than 0." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create part of a trained model definition.", @@ -20892,6 +25909,20 @@ "type": "array", "required": false, "summary": "The optional vocabulary value scores if required by the tokenizer." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a trained model vocabulary.", @@ -20930,6 +25961,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset an anomaly detection job.", @@ -20965,6 +26010,20 @@ "type": "boolean", "required": false, "summary": "Refer to the description for the `delete_intervening_results` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Revert to a snapshot.", @@ -20993,6 +26052,20 @@ "type": "string", "required": false, "summary": "The time to wait for the request to be completed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set upgrade_mode for ML indices.", @@ -21021,6 +26094,20 @@ "type": "string", "required": false, "summary": "Controls the amount of time to wait until the data frame analytics job starts." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start a data frame analytics job.", @@ -21063,6 +26150,20 @@ "type": "string", "required": false, "summary": "Refer to the description for the `timeout` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start datafeeds.", @@ -21140,6 +26241,20 @@ "type": "string", "required": false, "summary": "Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start a trained model deployment.", @@ -21182,6 +26297,20 @@ "type": "string", "required": false, "summary": "Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop data frame analytics jobs.", @@ -21231,6 +26360,20 @@ "type": "boolean", "required": false, "summary": "Refer to the description for the `close_job` query parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop datafeeds.", @@ -21273,6 +26416,20 @@ "type": "boolean", "required": false, "summary": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop a trained model deployment.", @@ -21322,6 +26479,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a data frame analytics job.", @@ -21470,6 +26641,20 @@ "type": "number", "required": false, "summary": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a datafeed.", @@ -21512,6 +26697,20 @@ "type": "array", "required": false, "summary": "The items to remove from the filter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a filter.", @@ -21634,6 +26833,20 @@ "type": "string", "required": false, "summary": "Settings related to how categorization interacts with partition fields." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an anomaly detection job.", @@ -21676,6 +26889,20 @@ "type": "boolean", "required": false, "summary": "If `true`, this snapshot will not be deleted during automatic cleanup of snapshots older than `model_snapshot_retention_days`. However, this snapshot will be deleted when the job is deleted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a snapshot.", @@ -21711,6 +26938,20 @@ "type": "string", "required": false, "summary": "Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a trained model deployment.", @@ -21753,6 +26994,20 @@ "type": "string", "required": false, "summary": "Controls the time to wait for the request to complete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upgrade a snapshot.", @@ -21789,6 +27044,20 @@ "type": "number", "required": true, "summary": "Specifies the maximum `archive_version` to be cleared from the archive." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the archived repositories metering.", @@ -21814,6 +27083,20 @@ "required": true, "summary": "Comma-separated list of node IDs or names used to limit returned information.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cluster repositories metering.", @@ -21888,6 +27171,20 @@ "type": "string", "required": false, "summary": "The sort order for 'cpu' type" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the hot threads for nodes.", @@ -21935,6 +27232,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get node information.", @@ -21974,6 +27285,20 @@ "type": "string", "required": false, "summary": "The password for the Elasticsearch keystore." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reload the keystore on nodes in the cluster.", @@ -22078,6 +27403,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the response includes information from segments that are not loaded into memory." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get node statistics.", @@ -22118,6 +27457,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get feature usage information.", @@ -22148,6 +27501,20 @@ "name": "expressions", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update project routing expressions.", @@ -22178,6 +27545,20 @@ "name": "expressions", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a project routing expression.", @@ -22202,6 +27583,20 @@ "type": "string", "required": true, "summary": "The name of project routing expression" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a project routing expression.", @@ -22219,7 +27614,22 @@ "project" ], "name": "get-many-routing", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get project routing expressions.", "intent": { "destructive": false, @@ -22242,6 +27652,20 @@ "type": "string", "required": true, "summary": "The name of project routing expression" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a project routing expression.", @@ -22259,7 +27683,22 @@ "project" ], "name": "tags", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get tags.", "intent": { "destructive": false, @@ -22296,6 +27735,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the query rule within the specified ruleset to delete" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a query rule.", @@ -22320,6 +27773,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the query ruleset to delete" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a query ruleset.", @@ -22351,6 +27818,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the query rule within the specified ruleset to retrieve" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a query rule.", @@ -22375,6 +27856,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the query ruleset" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a query ruleset.", @@ -22406,6 +27901,20 @@ "type": "number", "required": false, "summary": "The maximum number of results to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all query rulesets.", @@ -22470,6 +27979,20 @@ "name": "priority", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a query rule.", @@ -22502,6 +28025,20 @@ "required": true, "repeatable": true, "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a query ruleset.", @@ -22533,6 +28070,20 @@ "type": "string", "required": true, "summary": "The match criteria to apply to rules in the given query ruleset. Match criteria should match the keys defined in the `criteria.metadata` field of the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Test a query ruleset.", @@ -22561,6 +28112,20 @@ "type": "string", "required": true, "summary": "Identifier for the job." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a rollup job.", @@ -22585,6 +28150,20 @@ "type": "string", "required": false, "summary": "Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get rollup job information.", @@ -22609,6 +28188,20 @@ "type": "string", "required": false, "summary": "Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the rollup job capabilities.", @@ -22634,6 +28227,20 @@ "required": true, "summary": "Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the rollup index capabilities.", @@ -22713,6 +28320,20 @@ "name": "headers", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a rollup job.", @@ -22780,6 +28401,20 @@ "type": "number", "required": false, "summary": "Must be zero if set, as rollups work on pre-aggregated data." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Search rolled-up data.", @@ -22804,6 +28439,20 @@ "type": "string", "required": true, "summary": "Identifier for the rollup job." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start rollup jobs.", @@ -22839,6 +28488,20 @@ "type": "boolean", "required": false, "summary": "If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop rollup jobs.", @@ -22867,6 +28530,20 @@ "type": "string", "required": true, "summary": "The name of the search application to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a search application.", @@ -22891,6 +28568,20 @@ "type": "string", "required": true, "summary": "The name of the analytics collection to be deleted" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a behavioral analytics collection.", @@ -22915,6 +28606,20 @@ "type": "string", "required": true, "summary": "The name of the search application" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get search application details.", @@ -22939,6 +28644,20 @@ "type": "array", "required": false, "summary": "A list of analytics collections to limit the returned information" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get behavioral analytics collections.", @@ -22977,6 +28696,20 @@ "type": "number", "required": false, "summary": "Specifies a max number of results to get." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get search applications.", @@ -23026,6 +28759,20 @@ "name": "payload", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a behavioral analytics collection event.", @@ -23060,6 +28807,20 @@ "name": "search-application", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a search application.", @@ -23084,6 +28845,20 @@ "type": "string", "required": true, "summary": "The name of the analytics collection to be created or updated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a behavioral analytics collection.", @@ -23114,6 +28889,20 @@ "name": "params", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Render a search application query.", @@ -23149,6 +28938,20 @@ "type": "string", "required": false, "summary": "Query parameters specific to this request, which will override any defaults specified in the template." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a search application search.", @@ -23181,6 +28984,20 @@ "required": false, "summary": "The names of the nodes in the cluster to target.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cache statistics.", @@ -23228,6 +29045,20 @@ "type": "boolean", "required": false, "summary": "If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the cache.", @@ -23305,6 +29136,20 @@ "type": "array", "required": false, "summary": "The names of settings that should be removed from the index when it is mounted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Mount a snapshot.", @@ -23334,6 +29179,20 @@ "type": "string", "required": false, "summary": "Return stats aggregated at cluster, index or shard level" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get searchable snapshot statistics.", @@ -23390,6 +29249,20 @@ "type": "string", "required": false, "summary": "The username that identifies the user. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Activate a user profile.", @@ -23404,7 +29277,22 @@ "security" ], "name": "authenticate", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Authenticate a user.", "intent": { "destructive": false, @@ -23435,6 +29323,20 @@ "required": true, "summary": "An array of role names to delete", "elementType": "string" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk delete roles.", @@ -23466,6 +29368,20 @@ "type": "string", "required": true, "summary": "A dictionary of role name to RoleDescriptor objects to add or update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk create or update roles.", @@ -23510,6 +29426,20 @@ "type": "string", "required": false, "summary": "The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter. The structure of a role descriptor is the same as the request for the create API keys API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk update API keys.", @@ -23552,6 +29482,20 @@ "type": "string", "required": false, "summary": "A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Change passwords.", @@ -23577,6 +29521,20 @@ "required": true, "summary": "Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the API key cache.", @@ -23599,6 +29557,20 @@ "required": true, "summary": "A comma-separated list of applications. To clear all applications, use an asterism (`*`). It does not support other wildcard patterns.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the privileges cache.", @@ -23628,6 +29600,20 @@ "type": "array", "required": false, "summary": "A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the user cache.", @@ -23650,6 +29636,20 @@ "required": true, "summary": "A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk (`*`). It does not support other wildcard patterns.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear the roles cache.", @@ -23686,6 +29686,20 @@ "required": true, "summary": "A comma-separated list of token names to evict from the service account token caches. Use a wildcard (`*`) to evict all tokens that belong to a service account. It does not support other wildcard patterns.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear service account token caches.", @@ -23735,6 +29749,20 @@ "type": "string", "required": false, "summary": "Arbitrary metadata to associate with the cloned API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clone an API key.", @@ -23784,6 +29812,20 @@ "type": "string", "required": false, "summary": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an API key.", @@ -23836,6 +29878,20 @@ "type": "string", "required": false, "summary": "The certificate identity to associate with this API key. This field is used to restrict the API key to connections authenticated by a specific TLS certificate. The value should match the certificate's distinguished name (DN) pattern." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a cross-cluster API key.", @@ -23878,6 +29934,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a service account token.", @@ -23903,6 +29973,20 @@ "required": true, "summary": "The X509Certificate chain, which is represented as an ordered string array. Each string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding. The first element is the target certificate that contains the subject distinguished name that is requesting access. This may be followed by additional certificates; each subsequent certificate is used to certify the previous one.", "elementType": "string" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delegate PKI authentication.", @@ -23939,6 +30023,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete application privileges.", @@ -23970,6 +30068,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete roles.", @@ -24001,6 +30113,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete role mappings.", @@ -24046,6 +30172,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete service account tokens.", @@ -24077,6 +30217,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete users.", @@ -24108,6 +30262,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable users.", @@ -24139,6 +30307,20 @@ "type": "boolean", "required": false, "summary": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable a user profile.", @@ -24170,6 +30352,20 @@ "type": "boolean", "required": false, "summary": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable users.", @@ -24201,6 +30397,20 @@ "type": "boolean", "required": false, "summary": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable a user profile.", @@ -24218,7 +30428,22 @@ "security" ], "name": "enroll-kibana", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Enroll Kibana.", "intent": { "destructive": false, @@ -24234,7 +30459,22 @@ "security" ], "name": "enroll-node", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Enroll a node.", "intent": { "destructive": false, @@ -24306,6 +30546,20 @@ "type": "boolean", "required": false, "summary": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get API key information.", @@ -24323,7 +30577,22 @@ "security" ], "name": "get-builtin-privileges", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get builtin privileges.", "intent": { "destructive": false, @@ -24354,6 +30623,20 @@ "required": false, "summary": "The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get application privileges.", @@ -24386,6 +30669,20 @@ "type": "boolean", "required": false, "summary": "If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges. Each implicit entry in the response is annotated with `implicitly_granted: true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get roles.", @@ -24411,6 +30708,20 @@ "required": false, "summary": "The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get role mappings.", @@ -24442,6 +30753,20 @@ "type": "string", "required": false, "summary": "The service name. Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get service accounts.", @@ -24473,6 +30798,20 @@ "type": "string", "required": true, "summary": "The service name." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get service account credentials.", @@ -24497,6 +30836,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get security index settings.", @@ -24514,7 +30867,22 @@ "security" ], "name": "get-stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get security stats.", "intent": { "destructive": false, @@ -24572,6 +30940,20 @@ "type": "string", "required": false, "summary": "The username that identifies the user. If you specify the `password` grant type, this parameter is required. This parameter is not valid with any other supported grant type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a token.", @@ -24601,6 +30983,20 @@ "type": "boolean", "required": false, "summary": "Determines whether to retrieve the user profile UID, if it exists, for the users." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get users.", @@ -24618,7 +31014,22 @@ "security" ], "name": "get-user-privileges", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get user privileges.", "intent": { "destructive": false, @@ -24650,6 +31061,20 @@ "required": false, "summary": "A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=` to retrieve content nested under the specified ``. By default returns no `data` content.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a user profile.", @@ -24720,6 +31145,20 @@ "type": "string", "required": false, "summary": "The name of the user to be impersonated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Grant an API key.", @@ -24760,6 +31199,20 @@ "name": "index", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check user privileges.", @@ -24792,6 +31245,20 @@ "type": "string", "required": true, "summary": "An object containing all the privileges to be checked." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check user profile privileges.", @@ -24850,6 +31317,20 @@ "type": "string", "required": false, "summary": "The username of a user. This parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Invalidate API keys.", @@ -24895,6 +31376,20 @@ "type": "string", "required": false, "summary": "The username of a user. This parameter cannot be used with either `refresh_token` or `token`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Invalidate a token.", @@ -24940,6 +31435,20 @@ "type": "string", "required": true, "summary": "Maintain state between the authentication request and the response. This value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Authenticate OpenID Connect.", @@ -24968,6 +31477,20 @@ "type": "string", "required": false, "summary": "The refresh token to be invalidated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Logout of OpenID Connect.", @@ -25017,6 +31540,20 @@ "type": "string", "required": false, "summary": "The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation. If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Prepare OpenID connect authentication.", @@ -25044,6 +31581,20 @@ "name": "privileges", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update application privileges.", @@ -25124,6 +31675,20 @@ "type": "string", "required": false, "summary": "Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update roles.", @@ -25196,6 +31761,20 @@ "name": "run-as", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update role mappings.", @@ -25276,6 +31855,20 @@ "type": "boolean", "required": false, "summary": "Specifies whether the user is enabled." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update users.", @@ -25365,6 +31958,20 @@ "type": "array", "required": false, "summary": "The search after definition." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find API keys with a query.", @@ -25419,6 +32026,20 @@ "type": "array", "required": false, "summary": "The search after definition." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find roles with a query.", @@ -25480,6 +32101,20 @@ "type": "array", "required": false, "summary": "The search after definition" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find users with a query.", @@ -25520,6 +32155,20 @@ "type": "string", "required": false, "summary": "The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Authenticate SAML.", @@ -25564,6 +32213,20 @@ "type": "string", "required": false, "summary": "If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Logout of SAML completely.", @@ -25599,6 +32262,20 @@ "type": "string", "required": false, "summary": "The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the `acs` parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Invalidate SAML.", @@ -25627,6 +32304,20 @@ "type": "string", "required": false, "summary": "The refresh token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent refresh token that was received after refreshing the original access token." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Logout of SAML.", @@ -25662,6 +32353,20 @@ "type": "string", "required": false, "summary": "A string that will be included in the redirect URL that this API returns as the `RelayState` query parameter. If the Authentication Request is signed, this value is used as part of the signature computation." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Prepare SAML authentication.", @@ -25683,6 +32388,20 @@ "type": "string", "required": true, "summary": "The name of the SAML realm in Elasticsearch." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create SAML service provider metadata.", @@ -25730,6 +32449,20 @@ "type": "string", "required": false, "summary": "Extra search criteria to improve relevance of the suggestion result. Profiles matching the spcified hint are ranked higher in the response. Profiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Suggest a user profile.", @@ -25775,6 +32508,20 @@ "type": "string", "required": false, "summary": "The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the expiration unchanged." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an API key.", @@ -25827,6 +32574,20 @@ "type": "string", "required": false, "summary": "The certificate identity to associate with this API key. This field is used to restrict the API key to connections authenticated by a specific TLS certificate. The value should match the certificate's distinguished name (DN) pattern. When specified, this fully replaces any previously assigned certificate identity. To clear an existing certificate identity, explicitly set this field to `null`. When omitted, the existing certificate identity remains unchanged." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a cross-cluster API key.", @@ -25879,6 +32640,20 @@ "type": "string", "required": false, "summary": "Settings for the index used to store tokens." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update security index settings.", @@ -25938,6 +32713,20 @@ "type": "string", "required": false, "summary": "Non-searchable data that you want to associate with the user profile. This field supports a nested data structure. Within the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`). The data object is not searchable, but can be retrieved with the get user profile API." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update user profile data.", @@ -26017,6 +32806,20 @@ "type": "string", "required": false, "summary": "Pipelines to test. If you don’t specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Simulate data ingestion.", @@ -26062,6 +32865,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a policy.", @@ -26100,6 +32917,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a policy.", @@ -26131,6 +32962,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a retention policy.", @@ -26167,6 +33012,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get policy information.", @@ -26198,6 +33057,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get snapshot lifecycle management statistics.", @@ -26229,6 +33102,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the snapshot lifecycle management status.", @@ -26302,6 +33189,20 @@ "type": "string", "required": false, "summary": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a policy.", @@ -26333,6 +33234,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start snapshot lifecycle management.", @@ -26361,6 +33276,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop snapshot lifecycle management.", @@ -26382,7 +33311,22 @@ "snapshot" ], "name": "cleanup-repository", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Clean up the snapshot repository.", "intent": { "requiresAuth": true @@ -26430,6 +33374,20 @@ "type": "string", "required": true, "summary": "A comma-separated list of indices to include in the snapshot. Multi-target syntax is supported." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clone a snapshot.", @@ -26528,6 +33486,20 @@ "type": "boolean", "required": false, "summary": "If `true`, it enables you to restore a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a snapshot.", @@ -26545,7 +33517,22 @@ "snapshot" ], "name": "create-repository", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create or update a snapshot repository.", "intent": { "destructive": false, @@ -26590,6 +33577,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request returns a response when the matching snapshots are all deleted. If `false`, the request returns a response as soon as the deletes are scheduled." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete snapshots.", @@ -26607,7 +33608,22 @@ "snapshot" ], "name": "delete-repository", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete snapshot repositories.", "intent": { "destructive": true, @@ -26737,6 +33753,20 @@ "type": "boolean", "required": false, "summary": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get snapshot information.", @@ -26754,7 +33784,22 @@ "snapshot" ], "name": "get-repository", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get snapshot repository information.", "intent": { "destructive": false, @@ -26770,7 +33815,22 @@ "snapshot" ], "name": "repository-analyze", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Analyze a snapshot repository.", "intent": { "requiresAuth": true @@ -26783,7 +33843,22 @@ "snapshot" ], "name": "repository-verify-integrity", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Verify the repository integrity.", "intent": { "requiresAuth": true @@ -26896,6 +33971,20 @@ "type": "string", "required": false, "summary": "The rename replacement string that is used with the `rename_pattern`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restore a snapshot.", @@ -26939,6 +34028,20 @@ "type": "string", "required": false, "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the snapshot status.", @@ -26956,7 +34059,22 @@ "snapshot" ], "name": "verify-repository", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Verify a snapshot repository.", "intent": { "requiresAuth": true @@ -26983,6 +34101,20 @@ "type": "string", "required": true, "summary": "Cursor to clear." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clear an SQL search cursor.", @@ -27004,6 +34136,20 @@ "type": "string", "required": true, "summary": "The identifier for the search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an async SQL search.", @@ -27056,6 +34202,20 @@ "type": "string", "required": false, "summary": "The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get async SQL search results.", @@ -27080,6 +34240,20 @@ "type": "string", "required": true, "summary": "The identifier for the search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the async SQL search status.", @@ -27223,6 +34397,20 @@ "type": "string", "required": false, "summary": "The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results. If the search doesn't finish within this period, the search becomes async. To save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get SQL search results.", @@ -27265,6 +34453,20 @@ "type": "string", "required": false, "summary": "The ISO-8601 time zone ID for the search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Translate SQL into Elasticsearch queries.", @@ -27286,7 +34488,22 @@ "ssl" ], "name": "certificates", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get SSL certificates.", "intent": { "destructive": false, @@ -27335,6 +34552,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable a named stream.", @@ -27375,6 +34606,20 @@ "type": "string", "required": false, "summary": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable a named stream.", @@ -27396,6 +34641,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status of streams.", @@ -27427,6 +34686,20 @@ "type": "string", "required": true, "summary": "The synonyms set identifier to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a synonym set.", @@ -27458,6 +34731,20 @@ "type": "string", "required": true, "summary": "The ID of the synonym rule to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a synonym rule.", @@ -27496,6 +34783,20 @@ "type": "number", "required": false, "summary": "The max number of query rules to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a synonym set.", @@ -27527,6 +34828,20 @@ "type": "string", "required": true, "summary": "The ID of the synonym rule to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a synonym rule.", @@ -27558,6 +34873,20 @@ "type": "number", "required": false, "summary": "The maximum number of synonyms sets to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all synonym sets.", @@ -27591,6 +34920,20 @@ "summary": "The synonym rules definitions for the synonyms set.", "repeatable": true, "separator": "," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a synonym set.", @@ -27629,6 +34972,20 @@ "type": "string", "required": true, "summary": "The synonym rule information definition, which must be in Solr format." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a synonym rule.", @@ -27689,6 +35046,20 @@ "type": "boolean", "required": false, "summary": "If true, the request blocks until all found tasks are complete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel a task.", @@ -27724,6 +35095,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request blocks until the task has completed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get task information.", @@ -27792,6 +35177,20 @@ "type": "boolean", "required": false, "summary": "If `true`, the request blocks until the operation is complete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all tasks.", @@ -27922,6 +35321,20 @@ "type": "string", "required": false, "summary": "The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find the structure of a text field.", @@ -28032,6 +35445,20 @@ "required": true, "summary": "The list of messages you want to analyze.", "elementType": "string" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find the structure of text messages.", @@ -28168,6 +35595,20 @@ "name": "text-files", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find the structure of a text file.", @@ -28204,6 +35645,20 @@ "required": true, "summary": "The lines of text to run the Grok pattern on.", "elementType": "string" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Test a Grok pattern.", @@ -28256,6 +35711,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a transform.", @@ -28273,7 +35742,22 @@ "transform" ], "name": "get-node-stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get node stats.", "intent": { "destructive": false, @@ -28325,6 +35809,20 @@ "type": "boolean", "required": false, "summary": "Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get transforms.", @@ -28378,6 +35876,20 @@ "type": "string", "required": false, "summary": "Controls the time to wait for the stats" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get transform stats.", @@ -28472,6 +35984,20 @@ "type": "string", "required": false, "summary": "The latest method transforms the data by finding the latest document for each unique key." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview a transform.", @@ -28580,6 +36106,20 @@ "type": "string", "required": false, "summary": "Defines the properties transforms require to run continuously." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a transform.", @@ -28618,6 +36158,20 @@ "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset a transform.", @@ -28653,6 +36207,20 @@ "type": "boolean", "required": false, "summary": "When true, defers the scheduling by the transform's configured sync delay instead of triggering immediately. The transform will process new data after the delay elapses rather than right away." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Schedule a transform to start now.", @@ -28681,6 +36249,20 @@ "type": "string", "required": false, "summary": "The time to wait for the request to be completed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set upgrade_mode for transform indices.", @@ -28716,6 +36298,20 @@ "type": "string", "required": false, "summary": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start a transform.", @@ -28772,6 +36368,20 @@ "type": "boolean", "required": false, "summary": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop transforms.", @@ -28863,6 +36473,20 @@ "type": "string", "required": false, "summary": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a transform.", @@ -28878,12 +36502,26 @@ ], "name": "upgrade-transforms", "parameters": [ + { + "role": "flag", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "When true, the request checks for updates but does not run them." + }, { "role": "flag", "name": "timeout", "type": "string", "required": false, "summary": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" } ], "summary": "Upgrade all transforms.", @@ -28920,6 +36558,20 @@ "required": false, "summary": "A comma-separated list of the action identifiers to acknowledge. If you omit this parameter, all of the actions of the watch are acknowledged.", "repeatable": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Acknowledge a watch.", @@ -28944,6 +36596,20 @@ "type": "string", "required": true, "summary": "The watch identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Activate a watch.", @@ -28968,6 +36634,20 @@ "type": "string", "required": true, "summary": "The watch identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Deactivate a watch.", @@ -28992,6 +36672,20 @@ "type": "string", "required": true, "summary": "The watch identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a watch.", @@ -29071,6 +36765,20 @@ "type": "string", "required": false, "summary": "When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and `record_execution` cannot be set." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a watch.", @@ -29095,6 +36803,20 @@ "type": "string", "required": false, "summary": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Watcher index settings.", @@ -29119,6 +36841,20 @@ "type": "string", "required": true, "summary": "The watch identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a watch.", @@ -29227,6 +36963,20 @@ "type": "string", "required": false, "summary": "The trigger that defines when the watch should run." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a watch.", @@ -29281,6 +37031,20 @@ "type": "array", "required": false, "summary": "Retrieve the next page of hits using a set of sort values from the previous page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Query watches.", @@ -29305,6 +37069,20 @@ "type": "string", "required": false, "summary": "Period to wait for a connection to the master node." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start the watch service.", @@ -29334,6 +37112,20 @@ "type": "boolean", "required": false, "summary": "Defines whether stack traces are generated for each watch that is running." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Watcher statistics.", @@ -29358,6 +37150,20 @@ "type": "string", "required": false, "summary": "The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop the watch service.", @@ -29398,6 +37204,20 @@ "name": "index.number-of-replicas", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update Watcher index settings.", @@ -29443,280 +37263,23 @@ "type": "boolean", "required": false, "summary": "Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line." - } - ], - "summary": "Get information.", - "intent": { - "destructive": false, - "idempotent": true, - "scope": "global", - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "es", - "xpack" - ], - "name": "usage", - "parameters": [ - { - "role": "flag", - "name": "master-timeout", - "type": "string", - "required": false, - "summary": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." - } - ], - "summary": "Get usage information.", - "intent": { - "destructive": false, - "idempotent": true, - "scope": "global", - "requiresAuth": true - } - } - ], - "namespaces": [], - "summary": "Elasticsearch xpack API commands" - }, - { - "segment": "helpers", - "commands": [ - { - "path": [ - "stack", - "es", - "helpers" - ], - "name": "scroll-search", - "parameters": [ - { - "role": "flag", - "name": "index", - "type": "string", - "required": true, - "summary": "Target index" - }, - { - "role": "flag", - "name": "query", - "type": "string", - "required": false, - "summary": "Query DSL clause as JSON (wrapped under \"query\"), e.g. '{\"match_all\":{}}'" - }, - { - "role": "flag", - "name": "query-file", - "type": "string", - "required": false, - "summary": "Path to a file containing the full search body JSON (may include query, sort, aggs, ...)" - }, - { - "role": "flag", - "name": "scroll", - "type": "string", - "required": false, - "summary": "Scroll keep-alive duration", - "defaultValue": "1m" - }, - { - "role": "flag", - "name": "size", - "type": "number", - "required": false, - "summary": "Documents per scroll batch", - "defaultValue": "1000" - }, - { - "role": "flag", - "name": "max-docs", - "type": "number", - "required": false, - "summary": "Maximum total documents to fetch (default: unlimited)" - } - ], - "summary": "Scroll through all search results, streaming documents as NDJSON to stdout, or returning a single JSON object when --json is set.", - "intent": { - "destructive": false, - "idempotent": true, - "scope": "global", - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "es", - "helpers" - ], - "name": "bulk-ingest", - "parameters": [ - { - "role": "flag", - "name": "index", - "type": "string", - "required": true, - "summary": "Target index" - }, - { - "role": "flag", - "name": "data-file", - "type": "string", - "required": false, - "summary": "Path to data file (NDJSON, JSON array, or CSV)" - }, - { - "role": "flag", - "name": "data-dir", - "type": "string", - "required": false, - "summary": "Path to directory of data files to ingest" }, { "role": "flag", - "name": "glob", + "name": "input-file", "type": "string", "required": false, - "summary": "Glob pattern for --data-dir file matching (default: **/*.json, or **/*.csv when --source-format csv)" + "summary": "path to a JSON file to use as command input" }, { - "role": "flag", - "name": "no-recursive", + "role": "dryRun", + "name": "dry-run", "type": "boolean", "required": false, - "summary": "Do not recurse into subdirectories when using --data-dir" - }, - { - "role": "flag", - "name": "source-format", - "type": "enum", - "required": false, - "summary": "Input file format: ndjson, json, or csv", - "defaultValue": "ndjson", - "enumValues": [ - "ndjson", - "json", - "csv" - ] - }, - { - "role": "flag", - "name": "csv-delimiter", - "type": "string", - "required": false, - "summary": "CSV column delimiter (default: \",\")" - }, - { - "role": "flag", - "name": "csv-columns", - "type": "string", - "required": false, - "summary": "Comma-separated list of column names (overrides CSV header row)" - }, - { - "role": "flag", - "name": "skip-header", - "type": "boolean", - "required": false, - "summary": "Skip the first row of a CSV file" - }, - { - "role": "flag", - "name": "flush-bytes", - "type": "number", - "required": false, - "summary": "Batch size threshold in bytes", - "defaultValue": "5242880" - }, - { - "role": "flag", - "name": "concurrency", - "type": "number", - "required": false, - "summary": "Number of parallel bulk requests", - "defaultValue": "5" - }, - { - "role": "flag", - "name": "retries", - "type": "number", - "required": false, - "summary": "Max retries per failed batch", - "defaultValue": "3" - }, - { - "role": "flag", - "name": "retry-delay", - "type": "number", - "required": false, - "summary": "Initial retry delay in ms (doubles each attempt)", - "defaultValue": "1000" - }, - { - "role": "flag", - "name": "pipeline", - "type": "string", - "required": false, - "summary": "Ingest pipeline name" - }, - { - "role": "flag", - "name": "routing", - "type": "string", - "required": false, - "summary": "Custom routing value" - } - ], - "summary": "Bulk-ingest documents from file, directory, or stdin with automatic batching, concurrency, and retries.", - "intent": { - "destructive": false, - "idempotent": false, - "scope": "global", - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "es", - "helpers" - ], - "name": "msearch", - "parameters": [ - { - "role": "flag", - "name": "index", - "type": "string", - "required": false, - "summary": "Default index for searches" - }, - { - "role": "flag", - "name": "query-file", - "type": "string", - "required": false, - "summary": "Path to JSON file with search array" - }, - { - "role": "flag", - "name": "batch-size", - "type": "number", - "required": false, - "summary": "Searches per _msearch request", - "defaultValue": "5" - }, - { - "role": "flag", - "name": "concurrency", - "type": "number", - "required": false, - "summary": "Parallel _msearch requests", - "defaultValue": "5" + "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Batch multiple search requests via _msearch with configurable batch size and concurrency.", + "summary": "Get information.", "intent": { "destructive": false, "idempotent": true, @@ -29728,71 +37291,33 @@ "path": [ "stack", "es", - "helpers" + "xpack" ], - "name": "watch", + "name": "usage", "parameters": [ { "role": "flag", - "name": "index", - "type": "string", - "required": true, - "summary": "Index or data stream to watch" - }, - { - "role": "flag", - "name": "query", - "type": "string", - "required": false, - "summary": "Query DSL clause as JSON (wrapped under \"query\"), e.g. '{\"match\":{\"log.level\":\"error\"}}'" - }, - { - "role": "flag", - "name": "query-file", - "type": "string", - "required": false, - "summary": "Path to a file containing the full search body JSON" - }, - { - "role": "flag", - "name": "sort-field", + "name": "master-timeout", "type": "string", "required": false, - "summary": "Field to use for ordering and detecting new documents", - "defaultValue": "@timestamp" - }, - { - "role": "flag", - "name": "poll-interval", - "type": "number", - "required": false, - "summary": "Polling interval in milliseconds", - "defaultValue": "5000" + "summary": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`." }, { "role": "flag", - "name": "from", + "name": "input-file", "type": "string", "required": false, - "summary": "ISO 8601 timestamp to start from (e.g. \"2024-01-01T00:00:00Z\"). Defaults to the most recent document." + "summary": "path to a JSON file to use as command input" }, { - "role": "flag", - "name": "size", - "type": "number", - "required": false, - "summary": "Maximum documents to fetch per poll", - "defaultValue": "100" - }, - { - "role": "flag", - "name": "format", - "type": "string", + "role": "dryRun", + "name": "dry-run", + "type": "boolean", "required": false, - "summary": "Output template with {field} placeholders, e.g. \"{@timestamp} {message}\". Omit for NDJSON (_source as JSON)." + "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Watch an index for new documents and stream them to stdout as NDJSON.", + "summary": "Get usage information.", "intent": { "destructive": false, "idempotent": true, @@ -29802,7 +37327,7 @@ } ], "namespaces": [], - "summary": "High-level helper commands for common Elasticsearch workflows" + "summary": "Elasticsearch xpack API commands" } ], "summary": "Interact with the Elasticsearch API" @@ -29828,6 +37353,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the agent to send the A2A task to." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Send A2A task", @@ -29849,6 +37388,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the agent to get A2A metadata for." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get A2A agent card", @@ -29866,7 +37419,22 @@ "agent-builder" ], "name": "get-agent-builder-agents", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List agents", "intent": { "destructive": false, @@ -29938,6 +37506,20 @@ "type": "string", "required": false, "summary": "**Technical Preview; added in 9.4.0.** Optional visibility setting: `public` (any privileged user can read/write), `shared` (any privileged user can read, only owner can write), `private` (only owner can read/write)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an agent", @@ -30008,6 +37590,20 @@ "type": "array", "required": false, "summary": "Filter results to conversations by these usernames." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agent consumption data", @@ -30029,6 +37625,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the agent to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an agent", @@ -30053,6 +37663,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the agent to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent by ID", @@ -30126,6 +37750,20 @@ "type": "string", "required": false, "summary": "**Technical Preview; added in 9.4.0.** Updated visibility setting: `public` (any privileged user can read/write), `shared` (any privileged user can read, only owner can write), `private` (only owner can read/write)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an agent", @@ -30150,6 +37788,20 @@ "type": "string", "required": false, "summary": "Optional agent ID to filter conversations by a specific agent." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List conversations", @@ -30174,6 +37826,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the conversation to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete conversation by ID", @@ -30198,6 +37864,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the conversation to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get conversation by ID", @@ -30229,6 +37909,20 @@ "type": "boolean", "required": false, "summary": "Whether to include deleted attachments in the list." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List conversation attachments", @@ -30294,6 +37988,20 @@ "type": "string", "required": true, "summary": "The type of the attachment (e.g., text, esql, visualization)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create conversation attachment", @@ -30329,6 +38037,20 @@ "type": "boolean", "required": false, "summary": "If true, permanently removes the attachment (only for unreferenced attachments)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete conversation attachment", @@ -30367,6 +38089,20 @@ "type": "string", "required": true, "summary": "The new description/name for the attachment." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Rename attachment", @@ -30408,6 +38144,20 @@ "type": "string", "required": false, "summary": "Optional new description for the attachment." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update conversation attachment", @@ -30439,6 +38189,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the attachment to restore." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restore deleted attachment", @@ -30474,6 +38238,20 @@ "type": "string", "required": true, "summary": "The origin string (e.g., saved object ID for visualizations and dashboards)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update attachment origin", @@ -30498,6 +38276,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the conversation." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check attachment staleness", @@ -30592,6 +38384,20 @@ "type": "string", "required": false, "summary": "Can be used to respond to a confirmation prompt." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Send chat message", @@ -30683,6 +38489,20 @@ "type": "string", "required": false, "summary": "Can be used to respond to a confirmation prompt." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Send chat message (streaming)", @@ -30704,6 +38524,20 @@ "type": "string", "required": false, "summary": "Comma-separated list of namespaces to filter tools. Only tools matching the specified namespaces will be returned." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "MCP server", @@ -30718,7 +38552,22 @@ "agent-builder" ], "name": "get-agent-builder-plugins", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List plugins", "intent": { "destructive": false, @@ -30748,6 +38597,20 @@ "type": "boolean", "required": false, "summary": "If true, removes the plugin skills from agents that use them and then deletes the plugin. If false and any agent uses the plugin skills, the request returns 409 Conflict with the list of agents." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a plugin", @@ -30772,6 +38635,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the plugin." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a plugin by id", @@ -30803,6 +38680,20 @@ "type": "string", "required": true, "summary": "URL to install the plugin from (GitHub URL or direct zip URL)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install a plugin", @@ -30824,6 +38715,20 @@ "type": "boolean", "required": false, "summary": "Set to true to include skills from plugins." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List skills", @@ -30882,6 +38787,20 @@ "type": "array", "required": false, "summary": "Tool IDs from the tool registry that this skill references." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a skill", @@ -30910,6 +38829,20 @@ "type": "boolean", "required": false, "summary": "If true, removes the skill from agents that use it and then deletes it. If false and any agent uses the skill, the request returns 409 Conflict with the list of agents." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a skill", @@ -30934,6 +38867,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the skill." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a skill by id", @@ -30992,6 +38939,20 @@ "type": "array", "required": false, "summary": "Updated tool IDs from the tool registry." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a skill", @@ -31009,7 +38970,22 @@ "agent-builder" ], "name": "get-agent-builder-tools", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List tools", "intent": { "destructive": false, @@ -31060,6 +39036,20 @@ "type": "string", "required": true, "summary": "The type of tool to create (e.g., esql, index_search)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a tool", @@ -31095,6 +39085,20 @@ "type": "string", "required": true, "summary": "Parameters to pass to the tool execution. See examples for details" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a tool", @@ -31123,6 +39127,20 @@ "type": "boolean", "required": false, "summary": "If true, removes the tool from agents that use it and then deletes it. If false and any agent uses the tool, the request returns 409 Conflict with the list of agents." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a tool", @@ -31147,6 +39165,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the tool to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a tool by id", @@ -31192,6 +39224,20 @@ "type": "array", "required": false, "summary": "Updated tags for categorizing and organizing tools." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a tool", @@ -31223,6 +39269,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a rule", @@ -31247,6 +39307,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get rule details", @@ -31360,6 +39434,20 @@ "type": "string", "required": false, "summary": "The parameters for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a rule", @@ -31447,6 +39535,20 @@ "type": "string", "required": false, "summary": "Use the `throttle` property in the action `frequency` object instead. The throttle interval, which defines how often an alert generates repeated actions. NOTE: You cannot specify the throttle interval at both the rule and action level. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a rule", @@ -31478,6 +39580,20 @@ "type": "boolean", "required": false, "summary": "Defines whether this rule's alerts should be untracked." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable a rule", @@ -31499,6 +39615,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable a rule", @@ -31520,6 +39650,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Mute all alerts", @@ -31541,6 +39685,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unmute all alerts", @@ -31562,6 +39720,20 @@ "type": "string", "required": true, "summary": "The identifier for the rule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update the API key for a rule", @@ -31589,6 +39761,20 @@ "name": "schedule", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Schedule a snooze for the rule", @@ -31624,6 +39810,20 @@ "type": "boolean", "required": false, "summary": "Whether to validate the existence of the alert." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Mute an alert", @@ -31652,6 +39852,20 @@ "type": "string", "required": true, "summary": "The identifier for the alert." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unmute an alert", @@ -31680,6 +39894,20 @@ "type": "string", "required": true, "summary": "The identifier for the snooze schedule." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a snooze schedule for a rule", @@ -31773,6 +40001,20 @@ "name": "filter-consumers", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get information about rules", @@ -31846,6 +40088,20 @@ "type": "string", "required": false, "summary": "The sort order." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find backfills for rules", @@ -31860,7 +40116,22 @@ "alerting" ], "name": "post-alerting-rules-backfill-schedule", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Schedule a backfill for rules", "intent": { "requiresAuth": true @@ -31880,6 +40151,20 @@ "type": "string", "required": true, "summary": "The identifier for the backfill." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a backfill by ID", @@ -31904,6 +40189,20 @@ "type": "string", "required": true, "summary": "The identifier for the backfill." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a backfill by ID", @@ -31935,6 +40234,20 @@ "type": "string", "required": true, "summary": "Service" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete agent configuration", @@ -31952,7 +40265,22 @@ "apm-agent-configuration" ], "name": "get-agent-configurations", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get a list of agent configurations", "intent": { "destructive": false, @@ -31996,6 +40324,20 @@ "type": "string", "required": true, "summary": "Agent configuration settings" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update agent configuration", @@ -32020,6 +40362,20 @@ "type": "string", "required": true, "summary": "The name of the service" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agent name for service", @@ -32044,6 +40400,20 @@ "type": "string", "required": false, "summary": "The name of the service" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get environments for service", @@ -32082,6 +40452,20 @@ "type": "string", "required": true, "summary": "Service" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Lookup single agent configuration", @@ -32110,6 +40494,20 @@ "type": "string", "required": false, "summary": "Service environment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get single agent configuration", @@ -32148,6 +40546,20 @@ "type": "array", "required": true, "summary": "The APM agent key privileges. It can take one or more of the following values:" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an APM agent key", @@ -32204,6 +40616,20 @@ "type": "array", "required": false, "summary": "Tags are used by the Applications UI to distinguish APM annotations from other annotations. Tags may have additional functionality in future releases. It defaults to `[apm]`. While you can add additional tags, you cannot remove the `apm` tag." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a service annotation", @@ -32246,6 +40672,20 @@ "type": "string", "required": false, "summary": "The end date for the search" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Search for annotations", @@ -32277,6 +40717,20 @@ "type": "string", "required": false, "summary": "Schema object" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Save APM server schema", @@ -32312,6 +40766,20 @@ "type": "number", "required": false, "summary": "Number of records per page" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get source maps", @@ -32329,7 +40797,22 @@ "apm-sourcemaps" ], "name": "upload-source-map", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Upload a source map", "intent": { "requiresAuth": true @@ -32349,6 +40832,20 @@ "type": "string", "required": true, "summary": "Source map identifier" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete source map", @@ -32380,6 +40877,20 @@ "type": "string", "required": false, "summary": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get connector types", @@ -32432,6 +40943,20 @@ "type": "string", "required": false, "summary": "Session state from the OAuth provider (e.g., Microsoft)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Handle OAuth callback", @@ -32456,6 +40981,20 @@ "type": "string", "required": true, "summary": "An identifier for the connector." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a connector", @@ -32480,6 +41019,20 @@ "type": "string", "required": true, "summary": "An identifier for the connector." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get connector information", @@ -32531,6 +41084,20 @@ "name": "secrets", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a connector", @@ -32572,6 +41139,20 @@ "name": "secrets", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a connector", @@ -32602,6 +41183,20 @@ "name": "params", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a connector", @@ -32616,7 +41211,22 @@ "connectors" ], "name": "get-actions-connectors", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get all connectors", "intent": { "destructive": false, @@ -32639,7 +41249,22 @@ "data-streams" ], "name": "get-fleet-data-streams", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get data streams", "intent": { "destructive": false, @@ -32679,6 +41304,20 @@ "name": "uncategorised-only", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get data streams", @@ -32703,7 +41342,22 @@ "data-views" ], "name": "get-all-data-views-default", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get all data views", "intent": { "destructive": false, @@ -32733,6 +41387,20 @@ "type": "boolean", "required": false, "summary": "Override an existing data view if a data view with the provided title already exists." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a data view", @@ -32754,6 +41422,20 @@ "type": "string", "required": true, "summary": "The viewId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a data view", @@ -32778,6 +41460,20 @@ "type": "string", "required": true, "summary": "The viewId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a data view", @@ -32816,6 +41512,20 @@ "type": "boolean", "required": false, "summary": "Reloads the data view fields after the data view is updated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a data view", @@ -32844,6 +41554,20 @@ "type": "string", "required": true, "summary": "The field object." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update data view fields metadata", @@ -32879,6 +41603,20 @@ "type": "string", "required": true, "summary": "The runtime field definition object." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a runtime field", @@ -32914,6 +41652,20 @@ "type": "string", "required": true, "summary": "The runtime field definition object." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a runtime field", @@ -32945,6 +41697,20 @@ "type": "string", "required": true, "summary": "The fieldName parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a runtime field from a data view", @@ -32976,6 +41742,20 @@ "type": "string", "required": true, "summary": "The fieldName parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a runtime field", @@ -33014,6 +41794,20 @@ "type": "string", "required": true, "summary": "The runtime field definition object." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a runtime field", @@ -33028,7 +41822,22 @@ "data-views" ], "name": "get-default-data-view-default", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the default data view", "intent": { "destructive": false, @@ -33058,6 +41867,20 @@ "type": "boolean", "required": false, "summary": "Update an existing default data view identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set the default data view", @@ -33114,6 +41937,20 @@ "type": "string", "required": true, "summary": "New saved object reference value to replace the old value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Swap saved object references", @@ -33170,6 +42007,20 @@ "type": "string", "required": true, "summary": "New saved object reference value to replace the old value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview a saved object reference swap", @@ -33204,6 +42055,20 @@ "name": "action", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an agent action", @@ -33231,6 +42096,20 @@ "name": "policy-id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reassign an agent", @@ -33258,6 +42137,20 @@ "name": "additional-metrics", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Request agent diagnostics", @@ -33279,6 +42172,20 @@ "type": "string", "required": true, "summary": "The agent ID to rollback" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Rollback an agent", @@ -33312,6 +42219,20 @@ "name": "revoke", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unenroll an agent", @@ -33357,6 +42278,20 @@ "name": "kb-version", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upgrade an agent", @@ -33401,6 +42336,20 @@ "name": "error-size", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent action status", @@ -33425,6 +42374,20 @@ "type": "string", "required": true, "summary": "The actionId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel an agent action", @@ -33463,6 +42426,20 @@ "name": "policy-id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk reassign agents", @@ -33495,6 +42472,20 @@ "name": "batch-size", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk request diagnostics from agents", @@ -33527,6 +42518,20 @@ "name": "include-inactive", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk rollback agents", @@ -33574,6 +42579,20 @@ "type": "boolean", "required": false, "summary": "Revokes API keys of agents" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk unenroll agents", @@ -33618,6 +42637,20 @@ "name": "tags-to-remove", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk update agent tags", @@ -33686,6 +42719,20 @@ "name": "kb-version", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk upgrade agents", @@ -33707,7 +42754,22 @@ "elastic-agent-binary-download-sources" ], "name": "get-fleet-agent-download-sources", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get agent binary download sources", "intent": { "destructive": false, @@ -33772,6 +42834,20 @@ "name": "ssl", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an agent binary download source", @@ -33793,6 +42869,20 @@ "type": "string", "required": true, "summary": "The sourceId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an agent binary download source", @@ -33817,6 +42907,20 @@ "type": "string", "required": true, "summary": "The sourceId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent binary download source", @@ -33890,6 +42994,20 @@ "name": "ssl", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an agent binary download source", @@ -33977,6 +43095,20 @@ "name": "kb-format", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agent policies", @@ -34191,6 +43323,20 @@ "name": "unenroll-timeout", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an agent policy", @@ -34231,6 +43377,20 @@ "name": "ignore-missing", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk get agent policies", @@ -34258,6 +43418,20 @@ "name": "kb-format", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent policy", @@ -34485,6 +43659,20 @@ "name": "unenroll-timeout", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an agent policy", @@ -34509,6 +43697,20 @@ "type": "string", "required": true, "summary": "The agentPolicyId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get auto upgrade agent status", @@ -34551,6 +43753,20 @@ "name": "name", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Copy an agent policy", @@ -34600,6 +43816,20 @@ "type": "number", "required": false, "summary": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Download an agent policy", @@ -34652,6 +43882,20 @@ "type": "number", "required": false, "summary": "If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a full agent policy", @@ -34676,6 +43920,20 @@ "type": "string", "required": true, "summary": "The agentPolicyId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get outputs for an agent policy", @@ -34706,6 +43964,20 @@ "type": "boolean", "required": false, "summary": "bypass validation checks that can prevent agent policy deletion" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an agent policy", @@ -34727,6 +43999,20 @@ "type": "array", "required": true, "summary": "list of package policy ids" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get outputs for agent policies", @@ -34759,6 +44045,20 @@ "name": "enrol-token", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a full K8s agent manifest", @@ -34794,6 +44094,20 @@ "name": "enrol-token", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Download an agent manifest", @@ -34836,6 +44150,20 @@ "name": "kuery", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent status summary", @@ -34884,6 +44212,20 @@ "name": "preview-data", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get incoming agent data", @@ -34985,6 +44327,20 @@ "name": "pit-keep-alive", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agents", @@ -35008,6 +44364,20 @@ "name": "action-ids", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agents by action ids", @@ -35029,6 +44399,20 @@ "type": "string", "required": true, "summary": "The agentId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an agent", @@ -35059,6 +44443,20 @@ "name": "with-metrics", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an agent", @@ -35095,6 +44493,20 @@ "name": "user-provided-metadata", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an agent by ID", @@ -35137,6 +44549,20 @@ "name": "uri", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Migrate a single agent", @@ -35164,6 +44590,20 @@ "name": "user-info", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Change agent privilege level", @@ -35185,6 +44625,20 @@ "type": "string", "required": true, "summary": "The agentId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agent uploads", @@ -35202,7 +44656,22 @@ "elastic-agents" ], "name": "get-fleet-agents-available-versions", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get available agent versions", "intent": { "destructive": false, @@ -35248,6 +44717,20 @@ "name": "uri", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Migrate multiple agents", @@ -35280,6 +44763,20 @@ "name": "user-info", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk change agent privilege level", @@ -35301,6 +44798,20 @@ "type": "string", "required": true, "summary": "The fileId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an uploaded file", @@ -35332,6 +44843,20 @@ "type": "string", "required": true, "summary": "The fileName parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an uploaded file", @@ -35349,7 +44874,22 @@ "elastic-agents" ], "name": "get-fleet-agents-setup", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get agent setup info", "intent": { "destructive": false, @@ -35365,7 +44905,22 @@ "elastic-agents" ], "name": "post-fleet-agents-setup", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Initiate agent setup", "intent": { "requiresAuth": true @@ -35390,6 +44945,20 @@ "name": "show-inactive", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get agent tags", @@ -35420,6 +44989,20 @@ "name": "asset-ids", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk get assets", @@ -35446,6 +45029,20 @@ "name": "include-policy-templates", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get package categories", @@ -35481,6 +45078,20 @@ "name": "integration-name", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a custom integration", @@ -35514,6 +45125,20 @@ "name": "read-me-data", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a custom integration", @@ -35555,6 +45180,20 @@ "name": "with-package-policies-count", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get packages", @@ -35584,6 +45223,20 @@ "name": "skip-data-stream-rollover", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install a package by upload", @@ -35616,6 +45269,20 @@ "name": "packages", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk install packages", @@ -35636,6 +45303,20 @@ "name": "packages", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk rollback packages", @@ -35657,6 +45338,20 @@ "type": "string", "required": true, "summary": "Task ID of the bulk operation" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Bulk rollback packages details", @@ -35686,6 +45381,20 @@ "name": "packages", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk uninstall packages", @@ -35707,6 +45416,20 @@ "type": "string", "required": true, "summary": "Task ID of the bulk operation" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Bulk uninstall packages details", @@ -35748,6 +45471,20 @@ "name": "upgrade-package-policies", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk upgrade packages", @@ -35769,6 +45506,20 @@ "type": "string", "required": true, "summary": "Task ID of the bulk operation" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Bulk upgrade packages details", @@ -35799,6 +45550,20 @@ "name": "force", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a package", @@ -35847,6 +45612,20 @@ "name": "with-metadata", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a package", @@ -35908,6 +45687,20 @@ "name": "ignore-constraints", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install a package from the registry", @@ -35935,6 +45728,20 @@ "name": "keep-policies-up-to-date", "type": "boolean", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update package settings", @@ -35972,6 +45779,20 @@ "name": "force", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a package", @@ -36027,6 +45848,20 @@ "name": "with-metadata", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a package", @@ -36095,6 +45930,20 @@ "name": "ignore-constraints", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install a package from the registry", @@ -36129,6 +45978,20 @@ "name": "keep-policies-up-to-date", "type": "boolean", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update package settings", @@ -36167,6 +46030,20 @@ "type": "string", "required": true, "summary": "The filePath parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a package file", @@ -36204,6 +46081,20 @@ "name": "package-policy-id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete assets for an input package", @@ -36235,6 +46126,20 @@ "type": "string", "required": true, "summary": "The pkgVersion parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete Kibana assets for a package", @@ -36279,6 +46184,20 @@ "type": "array", "required": false, "summary": "When provided install assets in the specified spaces instead of the current space." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install Kibana assets for a package", @@ -36313,6 +46232,20 @@ "name": "force", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install Kibana alert rule for a package", @@ -36353,6 +46286,20 @@ "name": "transforms", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Authorize transforms", @@ -36386,6 +46333,20 @@ "name": "target-version", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Review a pending policy upgrade for a package with deprecations", @@ -36407,6 +46368,20 @@ "type": "string", "required": true, "summary": "Package name to roll back" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Rollback a package to previous version", @@ -36428,6 +46403,20 @@ "type": "string", "required": true, "summary": "The pkgName parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get package stats", @@ -36481,6 +46470,20 @@ "name": "sort-order", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get installed packages", @@ -36498,7 +46501,22 @@ "elastic-package-manager-epm" ], "name": "get-fleet-epm-packages-limited", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get a limited package list", "intent": { "destructive": false, @@ -36546,6 +46564,20 @@ "name": "ignore-unverified", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an inputs template", @@ -36563,7 +46595,22 @@ "elastic-package-manager-epm" ], "name": "get-fleet-epm-verification-key-id", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get a package signature verification key ID", "intent": { "destructive": false, @@ -36675,6 +46722,20 @@ "type": "string", "required": false, "summary": "Input/stream level variable. Refer to the integration documentation for more information." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an agentless policy", @@ -36703,6 +46764,20 @@ "type": "boolean", "required": false, "summary": "Force delete the policy even if the policy is managed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an agentless policy", @@ -36748,6 +46823,20 @@ "type": "string", "required": false, "summary": "KQL query to filter cloud connectors." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cloud connectors", @@ -36792,6 +46881,20 @@ "name": "vars", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create cloud connector", @@ -36820,6 +46923,20 @@ "type": "boolean", "required": false, "summary": "If true, forces deletion even if the cloud connector is in use." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete cloud connector (supports force deletion)", @@ -36844,6 +46961,20 @@ "type": "string", "required": true, "summary": "The unique identifier of the cloud connector." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cloud connector", @@ -36888,6 +47019,20 @@ "name": "vars", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update cloud connector", @@ -36926,6 +47071,20 @@ "type": "number", "required": false, "summary": "The number of items per page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get cloud connector usage (package policies using the connector)", @@ -36968,6 +47127,20 @@ "name": "kuery", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get enrollment API keys", @@ -37003,6 +47176,20 @@ "name": "policy-id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an enrollment API key", @@ -37024,6 +47211,20 @@ "type": "string", "required": true, "summary": "The keyId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Revoke an enrollment API key", @@ -37048,6 +47249,20 @@ "type": "string", "required": true, "summary": "The keyId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an enrollment API key", @@ -37078,6 +47293,20 @@ "name": "fleet-server-setup", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check permissions", @@ -37101,6 +47330,20 @@ "name": "id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Check Fleet Server health", @@ -37115,7 +47358,22 @@ "fleet-internals" ], "name": "get-fleet-settings", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get settings", "intent": { "destructive": false, @@ -37173,6 +47431,20 @@ "name": "prerelease-integrations-enabled", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update settings", @@ -37190,7 +47462,22 @@ "fleet-internals" ], "name": "post-fleet-setup", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Initiate Fleet setup", "intent": { "requiresAuth": true @@ -37210,7 +47497,22 @@ "fleet-outputs" ], "name": "post-fleet-logstash-api-keys", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Generate a Logstash API key", "intent": { "requiresAuth": true @@ -37223,7 +47525,22 @@ "fleet-outputs" ], "name": "get-fleet-outputs", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get outputs", "intent": { "destructive": false, @@ -37239,7 +47556,22 @@ "fleet-outputs" ], "name": "post-fleet-outputs", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create output", "intent": { "requiresAuth": true @@ -37259,6 +47591,20 @@ "type": "string", "required": true, "summary": "The outputId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete output", @@ -37283,6 +47629,20 @@ "type": "string", "required": true, "summary": "The outputId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get output", @@ -37307,6 +47667,20 @@ "type": "string", "required": true, "summary": "The outputId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update output", @@ -37331,6 +47705,20 @@ "type": "string", "required": true, "summary": "The outputId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the latest output health", @@ -37403,6 +47791,20 @@ "name": "with-agent-count", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get package policies", @@ -37426,6 +47828,20 @@ "name": "kb-format", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a package policy", @@ -37459,6 +47875,20 @@ "name": "ignore-missing", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk get package policies", @@ -37486,6 +47916,20 @@ "name": "force", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a package policy", @@ -37516,6 +47960,20 @@ "name": "kb-format", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a package policy", @@ -37546,6 +48004,20 @@ "name": "kb-format", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a package policy", @@ -37575,6 +48047,20 @@ "name": "package-policy-ids", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk delete package policies", @@ -37595,6 +48081,20 @@ "name": "package-policy-ids", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upgrade a package policy", @@ -37621,6 +48121,20 @@ "name": "package-version", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Dry run a package policy upgrade", @@ -37642,7 +48156,22 @@ "fleet-proxies" ], "name": "get-fleet-proxies", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get proxies", "intent": { "destructive": false, @@ -37706,6 +48235,20 @@ "name": "url", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a proxy", @@ -37727,6 +48270,20 @@ "type": "string", "required": true, "summary": "The itemId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a proxy", @@ -37751,6 +48308,20 @@ "type": "string", "required": true, "summary": "The itemId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a proxy", @@ -37811,6 +48382,20 @@ "name": "url", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a proxy", @@ -37835,7 +48420,22 @@ "fleet-server-hosts" ], "name": "get-fleet-fleet-server-hosts", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get Fleet Server hosts", "intent": { "destructive": false, @@ -37905,6 +48505,20 @@ "name": "ssl", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Fleet Server host", @@ -37926,6 +48540,20 @@ "type": "string", "required": true, "summary": "The itemId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a Fleet Server host", @@ -37950,6 +48578,20 @@ "type": "string", "required": true, "summary": "The itemId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a Fleet Server host", @@ -38016,6 +48658,20 @@ "name": "ssl", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a Fleet Server host", @@ -38066,6 +48722,20 @@ "name": "page", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get metadata for latest uninstall tokens", @@ -38090,6 +48760,20 @@ "type": "string", "required": true, "summary": "The uninstallTokenId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a decrypted uninstall token", @@ -38140,6 +48824,20 @@ "type": "string", "required": true, "summary": "The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a maintenance window.", @@ -38189,6 +48887,20 @@ "type": "number", "required": false, "summary": "The number of maintenance windows to return per page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Search for a maintenance window.", @@ -38213,6 +48925,20 @@ "type": "string", "required": true, "summary": "The identifier for the maintenance window to be deleted." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a maintenance window.", @@ -38237,6 +48963,20 @@ "type": "string", "required": true, "summary": "The identifier for the maintenance window." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get maintenance window details.", @@ -38287,6 +49027,20 @@ "type": "string", "required": false, "summary": "The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a maintenance window.", @@ -38308,6 +49062,20 @@ "type": "string", "required": true, "summary": "The identifier for the maintenance window to be archived." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Archive a maintenance window.", @@ -38329,6 +49097,20 @@ "type": "string", "required": true, "summary": "The identifier for the maintenance window to be unarchived." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unarchive a maintenance window.", @@ -38356,6 +49138,20 @@ "name": "acknowledge", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Rotate a Fleet message signing key pair", @@ -38377,7 +49173,22 @@ "misc" ], "name": "get-actions-connector-oauth-callback-script", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "intent": { "destructive": false, "idempotent": true, @@ -38392,7 +49203,22 @@ "misc" ], "name": "get-fleet-space-settings", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get space settings", "intent": { "destructive": false, @@ -38414,6 +49240,20 @@ "name": "allowed-namespace-prefixes", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create space settings", @@ -38461,6 +49301,20 @@ "name": "sort", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Query roles", @@ -38482,7 +49336,22 @@ "ml" ], "name": "ml-sync", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Sync saved objects in the default space", "intent": { "destructive": false, @@ -38498,7 +49367,22 @@ "ml" ], "name": "ml-update-jobs-spaces", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Update jobs spaces", "intent": { "requiresAuth": true @@ -38511,7 +49395,22 @@ "ml" ], "name": "ml-update-trained-models-spaces", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Update trained models spaces", "intent": { "requiresAuth": true @@ -38586,6 +49485,20 @@ "type": "string", "required": false, "summary": "A title for the conversation." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Generate a chat completion", @@ -38614,6 +49527,20 @@ "type": "boolean", "required": false, "summary": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all roles", @@ -38638,6 +49565,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a role", @@ -38669,6 +49610,20 @@ "type": "boolean", "required": false, "summary": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a role", @@ -38725,6 +49680,20 @@ "name": "metadata", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a role", @@ -38748,6 +49717,20 @@ "name": "roles", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update roles", @@ -38810,6 +49793,20 @@ "type": "string", "required": false, "summary": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export saved objects", @@ -38852,6 +49849,20 @@ "type": "string", "required": true, "summary": "A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import saved objects", @@ -38892,6 +49903,20 @@ "name": "retries", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resolve import errors", @@ -38934,6 +49959,20 @@ "type": "array", "required": false, "summary": "Array of anonymization fields to update." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Apply a bulk action to anonymization fields", @@ -38997,6 +50036,20 @@ "type": "boolean", "required": false, "summary": "If true, additionally fetch all anonymization fields, otherwise fetch only the provided page" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get anonymization fields", @@ -39091,6 +50144,20 @@ "type": "string", "required": false, "summary": "ISO language code for the assistant's response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a model response", @@ -39112,6 +50179,20 @@ "type": "array", "required": false, "summary": "Optional list of conversation IDs to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete conversations", @@ -39177,6 +50258,20 @@ "type": "string", "required": true, "summary": "The conversation title." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a conversation", @@ -39240,6 +50335,20 @@ "type": "boolean", "required": false, "summary": "Whether to return conversations that the current user owns. If true, only conversations owned by the user are returned." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get conversations", @@ -39264,6 +50373,20 @@ "type": "string", "required": true, "summary": "The conversation's `id` value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a conversation", @@ -39288,6 +50411,20 @@ "type": "string", "required": true, "summary": "The conversation's `id` value, a unique identifier for the conversation." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a conversation", @@ -39366,6 +50503,20 @@ "name": "users", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a conversation", @@ -39383,7 +50534,22 @@ "security-ai-assistant-api" ], "name": "get-knowledge-base", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Read a KnowledgeBase", "intent": { "destructive": false, @@ -39413,6 +50579,20 @@ "type": "boolean", "required": false, "summary": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a KnowledgeBase", @@ -39434,6 +50614,20 @@ "type": "string", "required": true, "summary": "The KnowledgeBase `resource` value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Read a KnowledgeBase for a resource", @@ -39472,6 +50666,20 @@ "type": "boolean", "required": false, "summary": "Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a KnowledgeBase for a resource", @@ -39486,7 +50694,22 @@ "security-ai-assistant-api" ], "name": "create-knowledge-base-entry", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create a Knowledge Base Entry", "intent": { "requiresAuth": true @@ -39519,6 +50742,20 @@ "type": "array", "required": false, "summary": "List of Knowledge Base Entries to update." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Applies a bulk action to multiple Knowledge Base Entries", @@ -39575,6 +50812,20 @@ "type": "number", "required": false, "summary": "Number of Knowledge Base Entries to return per page. Defaults to 20." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Finds Knowledge Base Entries that match the given query.", @@ -39599,6 +50850,20 @@ "type": "string", "required": true, "summary": "The unique identifier (`id`) of the Knowledge Base Entry to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Deletes a single Knowledge Base Entry using the `id` field", @@ -39623,6 +50888,20 @@ "type": "string", "required": true, "summary": "The unique identifier (`id`) of the Knowledge Base Entry to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Read a Knowledge Base Entry", @@ -39647,6 +50926,20 @@ "type": "string", "required": true, "summary": "The unique identifier (`id`) of the Knowledge Base Entry to update." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a Knowledge Base Entry", @@ -39685,6 +50978,20 @@ "type": "array", "required": false, "summary": "List of prompts to be updated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Apply a bulk action to prompts", @@ -39741,6 +51048,20 @@ "type": "number", "required": false, "summary": "Number of prompts per page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get prompts", @@ -39772,6 +51093,20 @@ "type": "string", "required": true, "summary": "Configuration object containing all parameters for the bulk update operation" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk update Attack discoveries", @@ -39898,6 +51233,20 @@ "type": "boolean", "required": false, "summary": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find Attack discoveries that match the search criteria", @@ -39985,6 +51334,20 @@ "name": "sub-action", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Generate attack discoveries from alerts", @@ -40020,6 +51383,20 @@ "type": "string", "required": false, "summary": "Start of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. \"now-7d\")." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the latest attack discovery generations metadata for the current user", @@ -40058,6 +51435,20 @@ "type": "boolean", "required": false, "summary": "When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to `true`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a single Attack discovery generation, including its discoveries and (optional) generation metadata", @@ -40082,6 +51473,20 @@ "type": "string", "required": true, "summary": "The unique identifier for the Attack discovery generation execution. This UUID is returned when an attack discovery generation is created and can be found in generation responses." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Dismiss an attack discovery generation", @@ -40130,6 +51535,20 @@ "name": "schedule", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create Attack discovery schedule", @@ -40172,6 +51591,20 @@ "type": "string", "required": false, "summary": "Sort order direction. Use 'asc' for ascending or 'desc' for descending. Defaults to 'asc'." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Finds Attack discovery schedules that match the search criteria", @@ -40196,6 +51629,20 @@ "type": "string", "required": true, "summary": "The unique identifier (UUID) of the Attack Discovery schedule to delete. This ID is returned when creating a schedule and can be found in schedule listings." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete Attack discovery schedule", @@ -40220,6 +51667,20 @@ "type": "string", "required": true, "summary": "The unique identifier (UUID) of the Attack Discovery schedule to retrieve. This ID is returned when creating a schedule and can be found in schedule listings." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Attack discovery schedule by ID", @@ -40271,6 +51732,20 @@ "name": "schedule", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update Attack discovery schedule", @@ -40295,6 +51770,20 @@ "type": "string", "required": true, "summary": "The unique identifier (UUID) of the Attack Discovery schedule to disable. This ID is returned when creating a schedule and can be found in schedule listings." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable Attack discovery schedule", @@ -40316,6 +51805,20 @@ "type": "string", "required": true, "summary": "The unique identifier (UUID) of the Attack Discovery schedule to enable. This ID is returned when creating a schedule and can be found in schedule listings." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable Attack discovery schedule", @@ -40337,7 +51840,22 @@ "security-detections-api" ], "name": "read-privileges", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Returns user privileges for the Kibana space", "intent": { "destructive": false, @@ -40367,6 +51885,20 @@ "type": "string", "required": false, "summary": "The rule's `rule_id` value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a detection rule", @@ -40398,6 +51930,20 @@ "type": "string", "required": false, "summary": "The rule's `rule_id` value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Retrieve a detection rule", @@ -40415,7 +51961,22 @@ "security-detections-api" ], "name": "patch-rule", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Patch a detection rule", "intent": { "requiresAuth": true @@ -40428,7 +51989,22 @@ "security-detections-api" ], "name": "create-rule", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create a detection rule", "intent": { "requiresAuth": true @@ -40441,7 +52017,22 @@ "security-detections-api" ], "name": "update-rule", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Update a detection rule", "intent": { "destructive": false, @@ -40464,6 +52055,20 @@ "type": "boolean", "required": false, "summary": "Enables dry run mode for the request call." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Apply a bulk action to detection rules", @@ -40499,6 +52104,20 @@ "type": "array", "required": true, "summary": "Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export detection rules", @@ -40582,6 +52201,20 @@ "type": "string", "required": false, "summary": "Gap auto fill scheduler ID used to determine gap fill status for rules" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List all detection rules", @@ -40627,6 +52260,20 @@ "type": "boolean", "required": false, "summary": "Generates a new list ID for each imported exception list." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import detection rules", @@ -40648,6 +52295,20 @@ "type": "boolean", "required": false, "summary": "Enables logging and returning in response ES queries, performed during rule execution" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview rule alerts generated on specified time range", @@ -40675,6 +52336,20 @@ "type": "array", "required": true, "summary": "A list of alerts `id`s." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Assign and unassign users from detection alerts", @@ -40737,6 +52412,20 @@ "name": "track-total-hits", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Find and/or aggregate detection alerts", @@ -40751,7 +52440,22 @@ "security-detections-api" ], "name": "set-alerts-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Set a detection alert status", "intent": { "requiresAuth": true @@ -40778,6 +52482,20 @@ "type": "string", "required": true, "summary": "Object with list of tags to add and remove." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add and remove detection alert tags", @@ -40792,7 +52510,22 @@ "security-detections-api" ], "name": "read-tags", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List all detection rule tags", "intent": { "destructive": false, @@ -40815,7 +52548,22 @@ "security-endpoint-exceptions-api" ], "name": "create-endpoint-list", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create an Elastic Endpoint rule exception list", "intent": { "requiresAuth": true @@ -40842,6 +52590,20 @@ "type": "string", "required": false, "summary": "Either `id` or `item_id` must be specified" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an Elastic Endpoint exception list item", @@ -40873,6 +52635,20 @@ "type": "string", "required": false, "summary": "Either `id` or `item_id` must be specified" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an Elastic Endpoint rule exception list item", @@ -40948,6 +52724,20 @@ "name": "type", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an Elastic Endpoint rule exception list item", @@ -41033,6 +52823,20 @@ "name": "type", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an Elastic Endpoint rule exception list item", @@ -41085,6 +52889,20 @@ "type": "string", "required": false, "summary": "Determines the sort order, which can be `desc` or `asc`" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Elastic Endpoint exception list items", @@ -41169,6 +52987,20 @@ "name": "types", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get response actions", @@ -41192,6 +53024,20 @@ "name": "query", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get response actions status", @@ -41216,6 +53062,20 @@ "type": "string", "required": true, "summary": "The action_id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get action details", @@ -41247,6 +53107,20 @@ "type": "string", "required": true, "summary": "The file identifier is constructed in one of two ways:" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get file information", @@ -41278,6 +53152,20 @@ "type": "string", "required": true, "summary": "The file identifier is constructed in one of two ways:" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Download a file", @@ -41336,6 +53224,20 @@ "name": "parameters", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel a response action", @@ -41391,6 +53293,20 @@ "name": "parameters", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a command", @@ -41446,6 +53362,20 @@ "name": "parameters", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a file", @@ -41500,66 +53430,163 @@ "role": "flag", "name": "parameters", "type": "string", - "required": false, - "summary": "Optional parameters object" - } - ], - "summary": "Isolate an endpoint", - "intent": { - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "kb", - "security-endpoint-management-api" - ], - "name": "endpoint-kill-process-action", - "parameters": [ - { - "role": "flag", - "name": "agent-type", - "type": "string", - "required": false, - "summary": "List of agent types to retrieve. Defaults to `endpoint`." - }, - { - "role": "flag", - "name": "alert-ids", - "type": "array", - "required": false, - "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50." - }, - { - "role": "flag", - "name": "case-ids", - "type": "array", - "required": false, - "summary": "The IDs of cases where the action taken will be logged. Max of 50." + "required": false, + "summary": "Optional parameters object" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Isolate an endpoint", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-kill-process-action", + "parameters": [ + { + "role": "flag", + "name": "agent-type", + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`." + }, + { + "role": "flag", + "name": "alert-ids", + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50." + }, + { + "role": "flag", + "name": "case-ids", + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50." + }, + { + "role": "flag", + "name": "comment", + "type": "string", + "required": false, + "summary": "Optional comment" + }, + { + "role": "flag", + "name": "endpoint-ids", + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250." + }, + { + "role": "flag", + "name": "parameters", + "type": "string", + "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], + "summary": "Terminate a process", + "intent": { + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "kb", + "security-endpoint-management-api" + ], + "name": "endpoint-generate-memory-dump", + "parameters": [ + { + "role": "flag", + "name": "agent-type", + "type": "string", + "required": false, + "summary": "List of agent types to retrieve. Defaults to `endpoint`." + }, + { + "role": "flag", + "name": "alert-ids", + "type": "array", + "required": false, + "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50." + }, + { + "role": "flag", + "name": "case-ids", + "type": "array", + "required": false, + "summary": "The IDs of cases where the action taken will be logged. Max of 50." + }, + { + "role": "flag", + "name": "comment", + "type": "string", + "required": false, + "summary": "Optional comment" + }, + { + "role": "flag", + "name": "endpoint-ids", + "type": "array", + "required": true, + "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250." + }, + { + "role": "flag", + "name": "parameters", + "type": "string", + "required": true }, { "role": "flag", - "name": "comment", + "name": "input-file", "type": "string", "required": false, - "summary": "Optional comment" - }, - { - "role": "flag", - "name": "endpoint-ids", - "type": "array", - "required": true, - "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250." + "summary": "path to a JSON file to use as command input" }, { - "role": "flag", - "name": "parameters", - "type": "string", - "required": true + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Terminate a process", + "summary": "Generate a memory dump from the host machine", "intent": { "requiresAuth": true } @@ -41570,7 +53597,7 @@ "kb", "security-endpoint-management-api" ], - "name": "endpoint-generate-memory-dump", + "name": "endpoint-get-processes-action", "parameters": [ { "role": "flag", @@ -41611,63 +53638,22 @@ "role": "flag", "name": "parameters", "type": "string", - "required": true - } - ], - "summary": "Generate a memory dump from the host machine", - "intent": { - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "kb", - "security-endpoint-management-api" - ], - "name": "endpoint-get-processes-action", - "parameters": [ - { - "role": "flag", - "name": "agent-type", - "type": "string", - "required": false, - "summary": "List of agent types to retrieve. Defaults to `endpoint`." - }, - { - "role": "flag", - "name": "alert-ids", - "type": "array", - "required": false, - "summary": "If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50." - }, - { - "role": "flag", - "name": "case-ids", - "type": "array", "required": false, - "summary": "The IDs of cases where the action taken will be logged. Max of 50." + "summary": "Optional parameters object" }, { "role": "flag", - "name": "comment", + "name": "input-file", "type": "string", "required": false, - "summary": "Optional comment" - }, - { - "role": "flag", - "name": "endpoint-ids", - "type": "array", - "required": true, - "summary": "List of endpoint IDs (cannot contain empty strings). Max of 250." + "summary": "path to a JSON file to use as command input" }, { - "role": "flag", - "name": "parameters", - "type": "string", + "role": "dryRun", + "name": "dry-run", + "type": "boolean", "required": false, - "summary": "Optional parameters object" + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get running processes", @@ -41724,6 +53710,20 @@ "type": "string", "required": true, "summary": "One of the following set of parameters must be provided" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a script", @@ -41779,6 +53779,20 @@ "name": "parameters", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Scan a file or directory", @@ -41793,7 +53807,22 @@ "security-endpoint-management-api" ], "name": "endpoint-get-actions-state", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get actions state", "intent": { "destructive": false, @@ -41850,6 +53879,20 @@ "name": "parameters", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Suspend a process", @@ -41906,6 +53949,20 @@ "type": "string", "required": false, "summary": "Optional parameters object" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Release an isolated endpoint", @@ -41920,7 +53977,22 @@ "security-endpoint-management-api" ], "name": "endpoint-upload-action", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Upload a file", "intent": { "requiresAuth": true @@ -41969,6 +54041,20 @@ "name": "sort-direction", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a metadata list", @@ -41993,6 +54079,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get metadata", @@ -42016,6 +54116,20 @@ "name": "query", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a policy response", @@ -42040,6 +54154,20 @@ "type": "string", "required": true, "summary": "The package_policy_id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a protection updates note", @@ -42070,6 +54198,20 @@ "name": "note", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a protection updates note", @@ -42112,6 +54254,20 @@ "type": "string", "required": false, "summary": "If 'wait_for' the request will wait for the index refresh." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an asset criticality record", @@ -42143,6 +54299,20 @@ "type": "string", "required": true, "summary": "The field representing the ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an asset criticality record", @@ -42167,6 +54337,20 @@ "type": "string", "required": false, "summary": "If 'wait_for' the request will wait for the index refresh." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upsert an asset criticality record", @@ -42187,6 +54371,20 @@ "name": "records", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk upsert asset criticality records", @@ -42236,6 +54434,20 @@ "type": "string", "required": false, "summary": "The kuery to filter by." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List asset criticality records", @@ -42260,6 +54472,20 @@ "type": "boolean", "required": false, "summary": "Whether to delete all the privileged user data" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete the Privilege Monitoring Engine", @@ -42277,7 +54503,22 @@ "security-entity-analytics-api" ], "name": "disable-monitoring-engine", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Disable the Privilege Monitoring Engine", "intent": { "requiresAuth": true @@ -42290,7 +54531,22 @@ "security-entity-analytics-api" ], "name": "init-monitoring-engine", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Initialize the Privilege Monitoring Engine", "intent": { "requiresAuth": true @@ -42303,7 +54559,22 @@ "security-entity-analytics-api" ], "name": "schedule-monitoring-engine", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Schedule the Privilege Monitoring Engine", "intent": { "requiresAuth": true @@ -42316,7 +54587,22 @@ "security-entity-analytics-api" ], "name": "priv-mon-health", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Health check on Privilege Monitoring", "intent": { "destructive": false, @@ -42332,7 +54618,22 @@ "security-entity-analytics-api" ], "name": "priv-mon-privileges", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Run a privileges check on Privilege Monitoring", "intent": { "destructive": false, @@ -42361,6 +54662,20 @@ "name": "user", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a new monitored user", @@ -42375,7 +54690,22 @@ "security-entity-analytics-api" ], "name": "privmon-bulk-upload-users-c-s-v", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Upsert multiple monitored users via CSV upload", "intent": { "requiresAuth": true @@ -42395,6 +54725,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a monitored user", @@ -42443,6 +54787,20 @@ "name": "user", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a monitored user", @@ -42467,6 +54825,20 @@ "type": "string", "required": false, "summary": "KQL query to filter the list of monitored users" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List all monitored users", @@ -42484,7 +54856,22 @@ "security-entity-analytics-api" ], "name": "install-privileged-access-detection-package", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Installs the privileged access detection package for the Entity Analytics privileged user monitoring experience", "intent": { "requiresAuth": true @@ -42497,7 +54884,22 @@ "security-entity-analytics-api" ], "name": "get-privileged-access-detection-package-status", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Gets the status of the privileged access detection package for the Entity Analytics privileged user monitoring experience", "intent": { "destructive": false, @@ -42548,6 +54950,20 @@ "type": "number", "required": true, "summary": "Risk score modifier associated with the watchlist" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a new watchlist", @@ -42569,6 +54985,20 @@ "type": "string", "required": true, "summary": "Unique ID of the watchlist" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a watchlist by ID", @@ -42621,6 +55051,20 @@ "type": "number", "required": true, "summary": "Risk score modifier associated with the watchlist" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an existing watchlist", @@ -42638,7 +55082,22 @@ "security-entity-analytics-api" ], "name": "list-watchlists", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List all watchlists", "intent": { "destructive": false, @@ -42735,6 +55194,20 @@ "type": "string", "required": false, "summary": "The field to use as the timestamp." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Initialize the Entity Store", @@ -42763,6 +55236,20 @@ "type": "boolean", "required": false, "summary": "Control flag to also delete the entity data." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete Entity Engines", @@ -42780,7 +55267,22 @@ "security-entity-analytics-api" ], "name": "list-entity-engines", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "List the Entity Engines", "intent": { "destructive": false, @@ -42817,6 +55319,20 @@ "type": "boolean", "required": false, "summary": "Control flag to also delete the entity data." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete the Entity Engine", @@ -42841,6 +55357,20 @@ "type": "string", "required": true, "summary": "The entity type of the engine (either 'user' or 'host')." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an Entity Engine", @@ -42940,6 +55470,20 @@ "type": "string", "required": false, "summary": "The field to use as the timestamp for the entity type." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Initialize an Entity Engine", @@ -42961,6 +55505,20 @@ "type": "string", "required": true, "summary": "The entity type of the engine" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start an Entity Engine", @@ -42982,6 +55540,20 @@ "type": "string", "required": true, "summary": "The entity type of the engine (either 'user' or 'host')." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop an Entity Engine", @@ -42996,7 +55568,22 @@ "security-entity-analytics-api" ], "name": "apply-entity-engine-dataview-indices", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Apply DataView indices to all installed engines", "intent": { "requiresAuth": true @@ -43023,6 +55610,20 @@ "type": "string", "required": true, "summary": "Identifier of the entity to be deleted, commonly entity.id value." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an entity in Entity Store", @@ -43053,6 +55654,20 @@ "name": "force", "type": "boolean", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upsert an entity in Entity Store", @@ -43082,6 +55697,20 @@ "name": "entities", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upsert many entities in Entity Store", @@ -43136,6 +55765,20 @@ "name": "entity-types", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List Entity Store Entities", @@ -43160,6 +55803,20 @@ "type": "boolean", "required": false, "summary": "If true returns a detailed status of the engine including all it's components" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status of the Entity Store", @@ -43177,7 +55834,22 @@ "security-entity-analytics-api" ], "name": "clean-up-risk-engine", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Cleanup the Risk Engine", "intent": { "destructive": true, @@ -43223,6 +55895,20 @@ "name": "range", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Configure the Risk Engine Saved Object", @@ -43237,7 +55923,22 @@ "security-entity-analytics-api" ], "name": "schedule-risk-engine-now", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Run the risk scoring engine", "intent": { "requiresAuth": true @@ -43270,6 +55971,20 @@ "name": "items", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create rule exception items", @@ -43304,6 +56019,20 @@ "name": "namespace-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an exception list", @@ -43341,6 +56070,20 @@ "name": "namespace-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get exception list details", @@ -43421,6 +56164,20 @@ "type": "number", "required": false, "summary": "The document version, automatically increasd on updates." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an exception list", @@ -43512,6 +56269,20 @@ "type": "number", "required": false, "summary": "The document version, automatically increasd on updates." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an exception list", @@ -43548,6 +56319,20 @@ "type": "string", "required": true, "summary": "Determines whether to include expired exceptions in the duplicated list. Expiration date defined by `expire_time`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Duplicate an exception list", @@ -43587,6 +56372,20 @@ "type": "string", "required": true, "summary": "Determines whether to include expired exceptions in the exported list. Expiration date defined by `expire_time`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export an exception list", @@ -43643,6 +56442,20 @@ "type": "string", "required": false, "summary": "Determines the sort order, which can be `desc` or `asc`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get exception lists", @@ -43674,6 +56487,20 @@ "type": "boolean", "required": false, "summary": "Determines whether the list being imported will have a new `list_id` generated." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import an exception list", @@ -43708,6 +56535,20 @@ "name": "namespace-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an exception list item", @@ -43745,6 +56586,20 @@ "name": "namespace-type", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an exception list item", @@ -43762,7 +56617,22 @@ "security-exceptions-api" ], "name": "create-exception-list-item", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create an exception list item", "intent": { "requiresAuth": true @@ -43775,7 +56645,22 @@ "security-exceptions-api" ], "name": "update-exception-list-item", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Update an exception list item", "intent": { "destructive": false, @@ -43846,6 +56731,20 @@ "type": "string", "required": false, "summary": "Determines the sort order, which can be `desc` or `asc`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get exception list items", @@ -43890,6 +56789,20 @@ "type": "string", "required": false, "summary": "Search filter clause" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an exception list summary", @@ -43921,6 +56834,20 @@ "type": "string", "required": true, "summary": "The name of the exception list." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a shared exception list", @@ -43962,6 +56889,20 @@ "type": "boolean", "required": false, "summary": "Determines whether to delete value list without performing any additional checks of where this list may be utilized." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a value list", @@ -43985,6 +56926,20 @@ "name": "id", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get value list details", @@ -44044,6 +56999,20 @@ "type": "number", "required": false, "summary": "The document version number." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Patch a value list", @@ -44099,6 +57068,20 @@ "name": "kb-version", "type": "number", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a value list", @@ -44155,6 +57138,20 @@ "type": "number", "required": false, "summary": "The document version number." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a value list", @@ -44214,6 +57211,20 @@ "type": "string", "required": false, "summary": "Filters the returned results according to the value of the specified field," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get value lists", @@ -44231,7 +57242,22 @@ "security-lists-api" ], "name": "delete-list-index", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete value list data streams", "intent": { "destructive": true, @@ -44247,7 +57273,22 @@ "security-lists-api" ], "name": "read-list-index", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get status of value list data streams", "intent": { "destructive": false, @@ -44263,7 +57304,22 @@ "security-lists-api" ], "name": "create-list-index", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create list data streams", "intent": { "requiresAuth": true @@ -44304,6 +57360,20 @@ "type": "string", "required": false, "summary": "Determines when changes made by the request are made visible to search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a value list item", @@ -44342,6 +57412,20 @@ "type": "string", "required": false, "summary": "The value used to evaluate exceptions. Required if `id` is not specified." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a value list item", @@ -44394,6 +57478,20 @@ "type": "string", "required": false, "summary": "The value used to evaluate exceptions." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Patch a value list item", @@ -44443,6 +57541,20 @@ "type": "string", "required": true, "summary": "The value used to evaluate exceptions." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a value list item", @@ -44485,6 +57597,20 @@ "type": "string", "required": true, "summary": "The value used to evaluate exceptions." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a value list item", @@ -44509,6 +57635,20 @@ "type": "string", "required": true, "summary": "Value list's `id` to export." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export value list items", @@ -44570,6 +57710,20 @@ "type": "string", "required": false, "summary": "Filters the returned results according to the value of the specified field," + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get value list items", @@ -44608,6 +57762,20 @@ "type": "string", "required": false, "summary": "Determines when changes made by the request are made visible to search." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import value list items", @@ -44622,7 +57790,22 @@ "security-lists-api" ], "name": "read-list-privileges", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get value list privileges", "intent": { "destructive": false, @@ -44675,6 +57858,20 @@ "name": "sort-order", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get live queries", @@ -44783,6 +57980,20 @@ "type": "string", "required": false, "summary": "The ID of a saved query." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a live query", @@ -44804,6 +58015,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get live query details", @@ -44865,6 +58090,20 @@ "name": "sort-order", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get live query results", @@ -44906,6 +58145,20 @@ "name": "sort-order", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get packs", @@ -44965,6 +58218,20 @@ "type": "string", "required": false, "summary": "An object with shard configuration for policies included in the pack. For each policy, set the shard configuration to a percentage (1–100) of target hosts." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a pack", @@ -44986,6 +58253,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a pack", @@ -45010,6 +58291,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get pack details", @@ -45076,6 +58371,20 @@ "type": "string", "required": false, "summary": "An object with shard configuration for policies included in the pack. For each policy, set the shard configuration to a percentage (1–100) of target hosts." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a pack", @@ -45117,6 +58426,20 @@ "name": "sort-order", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get saved queries", @@ -45197,6 +58520,20 @@ "type": "string", "required": false, "summary": "Uses the Osquery versions greater than or equal to the specified version string." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a saved query", @@ -45218,6 +58555,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a saved query", @@ -45242,6 +58593,20 @@ "type": "string", "required": true, "summary": "The id parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get saved query details", @@ -45329,6 +58694,20 @@ "type": "string", "required": false, "summary": "Uses the Osquery versions greater than or equal to the specified version string." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a saved query", @@ -45353,7 +58732,22 @@ "security-timeline-api" ], "name": "delete-note", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete a note", "intent": { "destructive": true, @@ -45429,6 +58823,20 @@ "name": "associated-filter", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get notes", @@ -45466,6 +58874,20 @@ "type": "string", "required": false, "summary": "The version of the note" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add or update a note", @@ -45501,6 +58923,20 @@ "type": "string", "required": true, "summary": "The `savedObjectId` of the timeline that you want this pinned event unpinned from." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Pin/unpin an event", @@ -45529,6 +58965,20 @@ "type": "array", "required": false, "summary": "Saved search IDs that should be deleted alongside the timelines" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete Timelines or Timeline templates", @@ -45560,6 +59010,20 @@ "type": "string", "required": false, "summary": "The `savedObjectId` of the Timeline to retrieve." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Timeline or Timeline template details", @@ -45597,6 +59061,20 @@ "type": "string", "required": true, "summary": "The version of the Timeline or Timeline template that you’re updating." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a Timeline", @@ -45658,6 +59136,20 @@ "name": "kb-version", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a Timeline or Timeline template", @@ -45684,6 +59176,20 @@ "name": "timeline-id-to-copy", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Copies timeline or timeline template", @@ -45707,6 +59213,20 @@ "name": "timeline-type", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get draft Timeline or Timeline template details", @@ -45731,6 +59251,20 @@ "type": "string", "required": true, "summary": "The type of Timeline." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a clean draft Timeline or Timeline template", @@ -45758,6 +59292,20 @@ "name": "ids", "type": "array", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export Timelines", @@ -45797,6 +59345,20 @@ "type": "string", "required": true, "summary": "The type of Timeline." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Favorite a Timeline or Timeline template", @@ -45824,6 +59386,20 @@ "type": "string", "required": false, "summary": "Whether the Timeline should be immutable" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import Timelines", @@ -45856,6 +59432,20 @@ "name": "timelines-to-update", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Install prepackaged Timelines", @@ -45884,6 +59474,20 @@ "type": "string", "required": false, "summary": "The ID of the timeline to resolve" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an existing saved Timeline or Timeline template", @@ -45954,6 +59558,20 @@ "name": "status", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Timelines or Timeline templates", @@ -46041,6 +59659,20 @@ "type": "boolean", "required": false, "summary": "Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a paginated list of SLOs", @@ -46141,6 +59773,20 @@ "type": "string", "required": true, "summary": "Defines properties for the SLO time window" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create an SLO", @@ -46169,6 +59815,20 @@ "type": "array", "required": true, "summary": "An array of SLO Definition id" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk delete SLO definitions and their associated summary and rollup data.", @@ -46197,6 +59857,20 @@ "type": "string", "required": true, "summary": "The spaceId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Retrieve the status of the bulk deletion", @@ -46235,6 +59909,20 @@ "type": "string", "required": true, "summary": "Policy that dictates which SLI documents to purge based on age" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Batch delete rollup and summary data", @@ -46263,6 +59951,20 @@ "type": "array", "required": true, "summary": "An array of slo id and instance id" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Batch delete rollup and summary data", @@ -46291,6 +59993,20 @@ "type": "string", "required": true, "summary": "The sloId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an SLO", @@ -46329,6 +60045,20 @@ "type": "string", "required": false, "summary": "the specific instanceId used by the summary calculation" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an SLO", @@ -46429,6 +60159,20 @@ "type": "string", "required": false, "summary": "Defines properties for the SLO time window" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an SLO", @@ -46460,6 +60204,20 @@ "type": "string", "required": true, "summary": "The sloId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset an SLO", @@ -46488,6 +60246,20 @@ "type": "string", "required": true, "summary": "The sloId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Disable an SLO", @@ -46516,6 +60288,20 @@ "type": "string", "required": true, "summary": "The sloId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Enable an SLO", @@ -46579,6 +60365,20 @@ "type": "number", "required": false, "summary": "Number of SLOs returned by page" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the SLO definitions", @@ -46617,6 +60417,20 @@ "type": "string", "required": true, "summary": "When enabled, the API returns any spaces that the user is authorized to access in any capacity and each space will contain the purposes for which the user is authorized. This can be useful to determine which spaces a user can read but not take a specific action in. If the security plugin is not enabled, this parameter has no effect, since no authorization checks take place. This parameter cannot be used in with the `purpose` parameter." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all spaces", @@ -46695,6 +60509,20 @@ "type": "string", "required": false, "summary": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a space", @@ -46716,6 +60544,20 @@ "type": "string", "required": true, "summary": "The space identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a space", @@ -46740,6 +60582,20 @@ "type": "string", "required": true, "summary": "The space identifier." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a space", @@ -46825,6 +60681,20 @@ "type": "string", "required": false, "summary": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a space", @@ -46849,7 +60719,22 @@ "streams" ], "name": "get-streams", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get stream list", "intent": { "destructive": false, @@ -46865,7 +60750,22 @@ "streams" ], "name": "post-streams-disable", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Disable streams", "intent": { "requiresAuth": true @@ -46878,7 +60778,22 @@ "streams" ], "name": "post-streams-enable", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Enable streams", "intent": { "requiresAuth": true @@ -46891,7 +60806,22 @@ "streams" ], "name": "post-streams-resync", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Resync streams", "intent": { "requiresAuth": true @@ -46911,6 +60841,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a stream", @@ -46935,6 +60879,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a stream", @@ -46959,6 +60917,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create or update a stream", @@ -47002,6 +60974,20 @@ "type": "string", "required": true, "summary": "The root condition object. It can be a simple filter or a combination of other conditions." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Fork a stream", @@ -47023,6 +61009,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get ingest stream settings", @@ -47053,6 +61053,20 @@ "name": "ingest", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update ingest stream settings", @@ -47077,6 +61091,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get query stream settings", @@ -47113,6 +61141,20 @@ "name": "query", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upsert query stream settings", @@ -47161,6 +61203,20 @@ "name": "kb-version", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export stream content", @@ -47182,6 +61238,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Import content into a stream", @@ -47203,6 +61273,20 @@ "type": "string", "required": true, "summary": "The name parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get stream queries", @@ -47233,6 +61317,20 @@ "name": "operations", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk update queries", @@ -47261,6 +61359,20 @@ "type": "string", "required": true, "summary": "The queryId parameter" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Remove a query from a stream", @@ -47323,6 +61435,20 @@ "type": "string", "required": true, "summary": "A non-empty string." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upsert a query to a stream", @@ -47379,6 +61505,20 @@ "type": "string", "required": false, "summary": "Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). Defaults to hybrid when inference is available." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Read the significant events", @@ -47429,6 +61569,20 @@ "type": "number", "required": false, "summary": "Number of sample documents to use for generation from the current data of stream" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Generate significant events", @@ -47474,6 +61628,20 @@ "name": "query", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Preview significant events", @@ -47516,6 +61684,20 @@ "type": "string", "required": false, "summary": "Filter by tags (single value or array)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get stream attachments", @@ -47546,6 +61728,20 @@ "name": "operations", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk update attachments", @@ -47581,6 +61777,20 @@ "type": "string", "required": true, "summary": "The ID of the attachment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Unlink an attachment from a stream", @@ -47619,6 +61829,20 @@ "type": "string", "required": true, "summary": "The ID of the attachment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Link an attachment to a stream", @@ -47657,6 +61881,20 @@ "type": "boolean", "required": false, "summary": "Set to \"true\" to get the response in v8 format." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Kibana's current status", @@ -47681,7 +61919,22 @@ "task-manager" ], "name": "task-manager-health", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get the task manager health", "intent": { "destructive": false, @@ -47718,6 +61971,20 @@ "type": "array", "required": true, "summary": "Array of workflow IDs to delete." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk delete workflows", @@ -47777,6 +62044,20 @@ "type": "string", "required": false, "summary": "Filter by tags." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflows", @@ -47807,6 +62088,20 @@ "name": "workflows", "type": "array", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Bulk create workflows", @@ -47828,6 +62123,20 @@ "type": "string", "required": true, "summary": "Fields to aggregate on." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflow aggregations", @@ -47845,7 +62154,22 @@ "workflows" ], "name": "get-workflows-connectors", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get available connectors", "intent": { "destructive": false, @@ -47882,6 +62206,20 @@ "type": "boolean", "required": false, "summary": "Include execution output data." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a workflow execution", @@ -47906,6 +62244,20 @@ "type": "string", "required": true, "summary": "Workflow execution ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel a workflow execution", @@ -47927,6 +62279,20 @@ "type": "string", "required": true, "summary": "Workflow execution ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get child executions", @@ -47986,6 +62352,20 @@ "type": "string", "required": false, "summary": "Sort order." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get execution logs", @@ -48017,6 +62397,20 @@ "type": "string", "required": true, "summary": "Input data to resume the execution with." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume a workflow execution", @@ -48045,6 +62439,20 @@ "type": "string", "required": true, "summary": "Step execution ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a step execution", @@ -48069,6 +62477,20 @@ "type": "array", "required": true, "summary": "Array of workflow IDs to export." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Export workflows", @@ -48097,6 +62519,20 @@ "type": "array", "required": false, "summary": "Array of source fields to include." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflows by IDs", @@ -48118,6 +62554,20 @@ "type": "boolean", "required": true, "summary": "When true, returns a permissive schema that allows additional properties. When false, returns a strict schema for full validation." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflow JSON schema", @@ -48135,7 +62585,22 @@ "workflows" ], "name": "get-workflows-stats", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Get workflow statistics", "intent": { "destructive": false, @@ -48186,6 +62651,20 @@ "type": "string", "required": true, "summary": "YAML definition of the workflow containing the step." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Test a workflow step", @@ -48221,6 +62700,20 @@ "type": "string", "required": false, "summary": "YAML definition to test." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Test a workflow", @@ -48247,6 +62740,20 @@ "name": "yaml", "type": "string", "required": true + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a workflow", @@ -48275,6 +62782,20 @@ "type": "boolean", "required": false, "summary": "When true, permanently deletes the workflow (hard delete) instead of soft-deleting it. The workflow ID becomes available for reuse." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a workflow", @@ -48299,6 +62820,20 @@ "type": "string", "required": true, "summary": "Workflow ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a workflow", @@ -48353,6 +62888,20 @@ "name": "yaml", "type": "string", "required": false + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a workflow", @@ -48377,6 +62926,20 @@ "type": "string", "required": true, "summary": "Workflow ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Clone a workflow", @@ -48412,6 +62975,20 @@ "type": "string", "required": false, "summary": "Optional metadata for the execution." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Run a workflow", @@ -48475,6 +63052,20 @@ "type": "number", "required": false, "summary": "Number of results per page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflow executions", @@ -48534,6 +63125,20 @@ "type": "number", "required": false, "summary": "Number of results per page." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get workflow step executions", @@ -48552,16 +63157,7 @@ "summary": "Interact with the Kibana API" } ], - "summary": "Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)", - "options": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - } - ] + "summary": "Interact with Elastic Stack components (Elasticsearch, Kibana, Fleet)" }, { "segment": "cloud", @@ -53444,6 +68040,13 @@ "type": "string", "required": false, "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ] }, @@ -53456,11 +68059,25 @@ ], "name": "search", "parameters": [ + { + "role": "positional", + "name": "query", + "type": "string", + "required": false, + "summary": "Search terms" + }, + { + "role": "flag", + "name": "accept-experimental", + "type": "boolean", + "required": false, + "summary": "Acknowledge that this command is experimental and may be removed; suppresses the warning" + }, { "role": "flag", "name": "query", "type": "string", - "required": true, + "required": false, "summary": "Search terms" }, { @@ -53492,33 +68109,28 @@ "name": "ask", "parameters": [ { - "role": "flag", + "role": "positional", "name": "question", "type": "string", - "required": true, + "required": false, "summary": "Question to ask" - } - ], - "summary": "Ask a question about Elastic documentation using AI (single answer)", - "intent": { - "requiresAuth": false - } - }, - { - "path": [ - "docs" - ], - "name": "chat", - "parameters": [ + }, + { + "role": "flag", + "name": "accept-experimental", + "type": "boolean", + "required": false, + "summary": "Acknowledge that this command is experimental and may be removed; suppresses the warning" + }, { "role": "flag", "name": "question", "type": "string", - "required": true, - "summary": "Opening question" + "required": false, + "summary": "Question to ask" } ], - "summary": "Ask a question about Elastic documentation using AI, with follow-up conversation", + "summary": "Ask a question about Elastic documentation using AI (single answer)", "intent": { "requiresAuth": false } @@ -53529,11 +68141,18 @@ ], "name": "read", "parameters": [ + { + "role": "positional", + "name": "path", + "type": "string", + "required": false, + "summary": "Docs path, full elastic.co URL, or search query" + }, { "role": "flag", "name": "path", "type": "string", - "required": true, + "required": false, "summary": "Docs path, full elastic.co URL, or search query" }, { @@ -53559,6 +68178,13 @@ "type": "string", "required": false, "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ] }, @@ -53861,6 +68487,13 @@ "type": "string", "required": false, "summary": "path to the config file to edit (defaults to ~/.elasticrc.yml)" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ] }, @@ -54021,7 +68654,16 @@ } ], "namespaces": [], - "summary": "Sanitize values for safe use in Elasticsearch" + "summary": "Sanitize values for safe use in Elasticsearch", + "options": [ + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ] } ], "description": "Interface with the Elastic Stack and Elastic Cloud from the command line." diff --git a/src/docs/ask.ts b/src/docs/ask.ts index 45b44010..a1007b17 100644 --- a/src/docs/ask.ts +++ b/src/docs/ask.ts @@ -23,18 +23,37 @@ const defaultDeps: AskDeps = { } const inputSchema = z.object({ - question: z.string().describe('Question to ask'), + question: z.string().optional().describe('Question to ask'), }) +function experimentalBanner (isTTY: boolean): string { + const text = + 'Warning: "docs ask" is experimental and in active development.\n' + + ' Not yet suited for scripts or automation. Pass --accept-experimental to suppress this warning.\n\n' + return isTTY ? `\x1b[33m${text}\x1b[0m` : text +} + export function createAskCommand (deps: AskDeps = defaultDeps): OpaqueCommandHandle { return defineCommand({ name: 'ask', description: 'Ask a question about Elastic documentation using AI (single answer)', input: inputSchema, + positionalArg: { name: 'question', description: 'Question to ask', required: false }, + options: [ + { + long: 'accept-experimental', + type: 'boolean', + description: 'Acknowledge that this command is experimental and may be removed; suppresses the warning', + }, + ], handler: async (parsed): Promise => { - const question = parsed.input!.question.trim() + const question = (parsed.arg ?? parsed.input?.question ?? '').trim() if (question === '') return { error: { code: 'missing_input', message: 'question is required' } } + if (parsed.options['accept-experimental'] !== true && parsed.options['json'] !== true) { + deps.stderr.write(experimentalBanner(process.stderr.isTTY === true)) + } + const conversationId = newUuid() const interactive = process.stderr.isTTY === true && parsed.options['json'] !== true const spinner = interactive ? startSpinner(deps.stderr, 'Thinking…') : undefined diff --git a/src/docs/read.ts b/src/docs/read.ts index 80d9299a..ee8105c1 100644 --- a/src/docs/read.ts +++ b/src/docs/read.ts @@ -22,7 +22,7 @@ const defaultDeps: ReadDeps = { } const inputSchema = z.object({ - path: z.string().describe('Docs path, full elastic.co URL, or search query'), + path: z.string().optional().describe('Docs path, full elastic.co URL, or search query'), raw: z.boolean().optional().describe('Output unrendered markdown instead of formatted output'), }) @@ -31,8 +31,9 @@ export function createReadCommand (deps: ReadDeps = defaultDeps): OpaqueCommandH name: 'read', description: 'Read an Elastic documentation page', input: inputSchema, + positionalArg: { name: 'path', description: 'Docs path, full elastic.co URL, or search query', required: false }, handler: async (parsed): Promise => { - const input = parsed.input!.path.trim() + const input = (parsed.arg ?? parsed.input?.path ?? '').trim() if (input === '') return { error: { code: 'missing_input', message: 'path is required' } } const raw = parsed.input!.raw === true diff --git a/src/docs/register.ts b/src/docs/register.ts index 5120f9a3..ab1a50d8 100644 --- a/src/docs/register.ts +++ b/src/docs/register.ts @@ -7,7 +7,6 @@ import { defineGroup } from '../factory.ts' import type { OpaqueCommandHandle } from '../factory.ts' import { createSearchCommand } from './search.ts' import { createAskCommand } from './ask.ts' -import { createChatCommand } from './chat.ts' import { createReadCommand } from './read.ts' export function registerDocsCommands (): OpaqueCommandHandle { @@ -15,7 +14,6 @@ export function registerDocsCommands (): OpaqueCommandHandle { { name: 'docs', description: 'Search, read, and ask questions about Elastic documentation' }, createSearchCommand(), createAskCommand(), - createChatCommand(), createReadCommand(), ) } diff --git a/src/docs/search.ts b/src/docs/search.ts index 5bbb9f75..2b813aa0 100644 --- a/src/docs/search.ts +++ b/src/docs/search.ts @@ -21,18 +21,38 @@ export interface SearchDeps { const defaultDeps: SearchDeps = { docsSearch, stderr: process.stderr } const inputSchema = z.object({ - query: z.string().describe('Search terms'), + query: z.string().optional().describe('Search terms'), page: z.number().default(1).describe('Page number'), size: z.number().default(5).describe('Results per page'), }) +function experimentalBanner (command: string, isTTY: boolean): string { + const text = + `Warning: "${command}" is experimental and in active development.\n` + + ` Not yet suited for scripts or automation. Pass --accept-experimental to suppress this warning.\n\n` + return isTTY ? `\x1b[33m${text}\x1b[0m` : text +} + export function createSearchCommand (deps: SearchDeps = defaultDeps): OpaqueCommandHandle { return defineCommand({ name: 'search', description: 'Search Elastic documentation', input: inputSchema, + positionalArg: { name: 'query', description: 'Search terms', required: false }, + options: [ + { + long: 'accept-experimental', + type: 'boolean', + description: 'Acknowledge that this command is experimental and may be removed; suppresses the warning', + }, + ], handler: async (parsed) => { - const { query, page, size } = parsed.input! + if (parsed.options['accept-experimental'] !== true && parsed.options['json'] !== true) { + deps.stderr.write(experimentalBanner('docs search', process.stderr.isTTY === true)) + } + const query = (parsed.arg ?? parsed.input?.query ?? '').trim() + if (query === '') return { error: { code: 'missing_input', message: 'query is required' } } + const { page, size } = parsed.input! try { const resp = await deps.docsSearch(query, page, size) diff --git a/test/docs/ask.test.ts b/test/docs/ask.test.ts index 3fa4ed41..3c39a96c 100644 --- a/test/docs/ask.test.ts +++ b/test/docs/ask.test.ts @@ -21,9 +21,9 @@ describe('createAskCommand', () => { assert.equal(cmd.name(), 'ask') }) - it('has a required --question option', () => { + it('accepts question as a positional argument or --question option', () => { const cmd = createAskCommand() - assert.equal(cmd.registeredArguments.length, 0) + assert.equal(cmd.registeredArguments.length, 1) const optNames = cmd.options.map((o) => o.long) assert.ok(optNames.includes('--question')) }) diff --git a/test/docs/read.test.ts b/test/docs/read.test.ts index c96c0d61..c040cedb 100644 --- a/test/docs/read.test.ts +++ b/test/docs/read.test.ts @@ -14,9 +14,9 @@ describe('createReadCommand', () => { assert.equal(cmd.name(), 'read') }) - it('has a required --path option', () => { + it('accepts path as a positional argument or --path option', () => { const cmd = createReadCommand() - assert.equal(cmd.registeredArguments.length, 0) + assert.equal(cmd.registeredArguments.length, 1) const optNames = cmd.options.map((o) => o.long) assert.ok(optNames.includes('--path')) }) diff --git a/test/docs/search.test.ts b/test/docs/search.test.ts index 66211394..c6605862 100644 --- a/test/docs/search.test.ts +++ b/test/docs/search.test.ts @@ -38,9 +38,9 @@ describe('createSearchCommand', () => { assert.equal(cmd.name(), 'search') }) - it('has a required --query option', () => { + it('accepts query as a positional argument or --query option', () => { const cmd = createSearchCommand() - assert.equal(cmd.registeredArguments.length, 0) + assert.equal(cmd.registeredArguments.length, 1) const optNames = cmd.options.map((o) => o.long) assert.ok(optNames.includes('--query')) })