From de13b50706fca7f1cbde528d6055d1241470a3fa Mon Sep 17 00:00:00 2001 From: reubenmiller Date: Sat, 26 Nov 2022 22:40:35 +0100 Subject: [PATCH] update cli docs --- .../docs/cli/c8y/agents/c8y_agents_create.md | 2 +- .../docs/cli/c8y/agents/c8y_agents_update.md | 2 +- .../docs/cli/c8y/alarms/c8y_alarms_create.md | 2 +- .../docs/cli/c8y/alarms/c8y_alarms_update.md | 2 +- .../c8y/alarms/c8y_alarms_updateCollection.md | 2 +- docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md | 2 +- .../applications/c8y_applications_create.md | 2 +- ...8y_applications_createHostedApplication.md | 2 +- .../applications/c8y_applications_update.md | 2 +- .../auditrecords/c8y_auditrecords_create.md | 2 +- .../cli/c8y/binaries/c8y_binaries_create.md | 2 +- .../c8y_bulkoperations_create.md | 2 +- .../c8y_bulkoperations_update.md | 2 +- .../configuration/c8y_configuration_create.md | 2 +- .../configuration/c8y_configuration_send.md | 110 ++ .../configuration/c8y_configuration_update.md | 2 +- .../c8y_currentapplication_update.md | 2 +- .../c8y/databroker/c8y_databroker_update.md | 2 +- .../devicegroups/c8y_devicegroups_create.md | 2 +- .../devicegroups/c8y_devicegroups_update.md | 2 +- .../c8y_devicegroups_children_create.md | 2 +- ...8y_devicemanagement_certificates_create.md | 2 +- ...8y_devicemanagement_certificates_update.md | 2 +- .../c8y_deviceprofiles_create.md | 2 +- .../c8y_deviceprofiles_update.md | 2 +- .../cli/c8y/devices/c8y_devices_create.md | 2 +- .../cli/c8y/devices/c8y_devices_update.md | 13 +- .../children/c8y_devices_children_create.md | 2 +- .../services/c8y_devices_services_create.md | 2 +- .../services/c8y_devices_services_update.md | 2 +- .../docs/cli/c8y/events/c8y_events_create.md | 2 +- .../docs/cli/c8y/events/c8y_events_update.md | 2 +- .../cli/c8y/firmware/c8y_firmware_create.md | 2 +- .../cli/c8y/firmware/c8y_firmware_update.md | 2 +- .../patches/c8y_firmware_patches_create.md | 5 +- .../versions/c8y_firmware_versions_create.md | 5 +- .../versions/c8y_firmware_versions_install.md | 2 +- .../cli/c8y/identity/c8y_identity_create.md | 2 +- .../cli/c8y/inventory/c8y_inventory_create.md | 2 +- .../cli/c8y/inventory/c8y_inventory_update.md | 5 +- .../children/c8y_inventory_children_create.md | 2 +- .../measurements/c8y_measurements_create.md | 2 +- .../c8y_measurements_createBulk.md | 2 +- .../microservices/c8y_microservices_create.md | 2 +- .../microservices/c8y_microservices_update.md | 2 +- .../c8y_microservices_serviceusers_create.md | 10 +- .../c8y_notification2_subscriptions_create.md | 2 +- .../tokens/c8y_notification2_tokens_create.md | 2 +- .../c8y/operations/c8y_operations_create.md | 2 +- .../c8y/operations/c8y_operations_update.md | 2 +- .../c8y_retentionrules_create.md | 2 +- .../c8y_retentionrules_update.md | 2 +- .../cli/c8y/sessions/c8y_sessions_create.md | 5 + .../docs/cli/c8y/sessions/c8y_sessions_set.md | 1 + .../c8y/smartgroups/c8y_smartgroups_create.md | 2 +- .../c8y/smartgroups/c8y_smartgroups_update.md | 2 +- .../cli/c8y/software/c8y_software_create.md | 2 +- .../cli/c8y/software/c8y_software_update.md | 2 +- .../versions/c8y_software_versions_create.md | 5 +- .../versions/c8y_software_versions_install.md | 2 +- .../c8y_software_versions_uninstall.md | 2 +- .../cli/c8y/template/c8y_template_execute.md | 2 +- .../c8y_tenantoptions_updateBulk.md | 2 +- .../cli/c8y/tenants/c8y_tenants_create.md | 2 +- .../cli/c8y/tenants/c8y_tenants_update.md | 2 +- .../c8y/usergroups/c8y_usergroups_create.md | 2 +- .../c8y/usergroups/c8y_usergroups_update.md | 2 +- .../docs/cli/c8y/users/c8y_users_create.md | 2 +- .../docs/cli/c8y/users/c8y_users_update.md | 2 +- .../psc8y/Configuration/Send-Configuration.md | 942 ++++++++++++++++++ .../docs/cli/psc8y/Sessions/New-Session.md | 17 + 71 files changed, 1167 insertions(+), 71 deletions(-) create mode 100644 docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_send.md create mode 100644 docs/go-c8y-cli/docs/cli/psc8y/Configuration/Send-Configuration.md diff --git a/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md b/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md index 830869dc2..b7d98e7e7 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md @@ -28,7 +28,7 @@ Create agent with custom properties ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --name string Agent name (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md b/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md index 2a3bf994a..3906e9a0d 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md @@ -23,7 +23,7 @@ Update agent by id ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Agent ID (required) (accepts pipeline) --newName string Agent name diff --git a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md index b3184c75e..269c797eb 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md @@ -23,7 +23,7 @@ Create a new alarm for device ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The ManagedObject that the alarm originated from (accepts pipeline) -h, --help help for create --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md index 736b6b586..1cfa10137 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md @@ -26,7 +26,7 @@ Update severity of an existing alarm to CRITICAL ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Alarm id (required) (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_updateCollection.md b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_updateCollection.md index 41dc9167d..5f9eb3525 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_updateCollection.md +++ b/docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_updateCollection.md @@ -25,7 +25,7 @@ Update the status of all active alarms on a device to ACKNOWLEDGED ``` --createdFrom string Start date or date and time of the alarm creation. Version >= 10.11 --createdTo string End date or date and time of the alarm creation. Version >= 10.11 - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --dateFrom string Start date or date and time of alarm occurrence. --dateTo string End date or date and time of alarm occurrence. --device strings The ManagedObject that the alarm originated from (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md b/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md index 79fc877ca..44d55a939 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md +++ b/docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md @@ -47,7 +47,7 @@ a template to also build the request's body from the piped input data. ``` --accept string accept (header) --contentType string content type (header) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string File to be uploaded as a binary --formdata string form data (json or shorthand json) -h, --help help for api diff --git a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_create.md b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_create.md index f662f5ce4..3c5d6ab5f 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_create.md @@ -25,7 +25,7 @@ Create a new hosted application ``` --availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default) --contextPath string contextPath of the hosted application. Required when application type is HOSTED - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --externalUrl string URL to the external application. Required when application type is EXTERNAL -h, --help help for create --key string Shared secret of application diff --git a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_createHostedApplication.md b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_createHostedApplication.md index 1e2f2e4e5..f9434c948 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_createHostedApplication.md +++ b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_createHostedApplication.md @@ -34,7 +34,7 @@ Create/update hosted web application but don't activate it, so the current versi ``` --availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default) --contextPath string contextPath of the hosted application - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string File or Folder of the web application. It should contain a index.html file in the root folder/ or zip file -h, --help help for createHostedApplication --key string Shared secret of application. Defaults to the value inside the cumulocity.json file (if present) diff --git a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_update.md b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_update.md index da8a31fdd..33b52be74 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/applications/c8y_applications_update.md @@ -25,7 +25,7 @@ Update application availability to MARKET ``` --availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default) --contextPath string contextPath of the hosted application - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --externalUrl string URL to the external application -h, --help help for update --id string Application id (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/auditrecords/c8y_auditrecords_create.md b/docs/go-c8y-cli/docs/cli/c8y/auditrecords/c8y_auditrecords_create.md index fafb09da8..e87dc8b21 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/auditrecords/c8y_auditrecords_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/auditrecords/c8y_auditrecords_create.md @@ -25,7 +25,7 @@ Create an audit record for a custom managed object update ``` --activity string The activity that was carried out. --application string The application used to carry out the audited action. - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --processingMode string Cumulocity processing mode --severity string The severity of action: critical, major, minor, warning or information. diff --git a/docs/go-c8y-cli/docs/cli/c8y/binaries/c8y_binaries_create.md b/docs/go-c8y-cli/docs/cli/c8y/binaries/c8y_binaries_create.md index 44696d1c7..202757f6e 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/binaries/c8y_binaries_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/binaries/c8y_binaries_create.md @@ -30,7 +30,7 @@ Upload a file with a custom name and custom meta information ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string File to be uploaded as a binary (required) -h, --help help for create --name string Set the name of the binary file. This will be the name of the file when it is downloaded in the UI diff --git a/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_create.md b/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_create.md index a11ebc259..92e803b91 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_create.md @@ -27,7 +27,7 @@ Create bulk operation for a group (using pipeline) ``` --creationRampSec float32 Delay between every operation creation. - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --group strings Identifies the target group on which this operation should be performed. (accepts pipeline) -h, --help help for create --operation string Operation prototype to send to each device in the group diff --git a/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_update.md b/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_update.md index 1e852170d..b04e6c0d9 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/bulkoperations/c8y_bulkoperations_update.md @@ -24,7 +24,7 @@ Update an bulk operation ``` --creationRampSec float32 Delay between every operation creation. - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Bulk Operation id (required) (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_create.md b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_create.md index d9274e69f..c9d437e8d 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_create.md @@ -30,7 +30,7 @@ available for multiple device types ``` --configurationType string Configuration type - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the configuration package --deviceType string Device type filter. Only allow configuration to be applied to devices of this type (accepts pipeline) --file string File to upload diff --git a/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_send.md b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_send.md new file mode 100644 index 000000000..646d42f0d --- /dev/null +++ b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_send.md @@ -0,0 +1,110 @@ +--- +category: configuration +title: c8y configuration send +--- +Send configuration to a device via an operation + +### Synopsis + +Create a new operation to send configuration to an agent or device. + +If you provide the reference to the configuration (via id or name), then the configuration's +url and type will be automatically added to the operation. + +You may also manually set the url and configurationType rather than looking up the configuration +file in the configuration repository. + + +``` +c8y configuration send [flags] +``` + +### Examples + +``` +$ c8y configuration send --device mydevice --configuration 12345 +Send a configuration file to a device + +$ c8y devices list | c8y configuration send --configuration 12345 +Send a configuration file to multiple devices + +$ c8y devices list | c8y configuration send --configuration my-config-name +Send a configuration file (by name) to multiple devices + +$ c8y configuration send --device 12345 --configurationType apt-lists --url "http://example.com/myrepo.list" +Send a custom configuration by manually providing the type and url + +``` + +### Options + +``` + --configuration strings Configuration name or id + --configurationType string Configuration type. Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + --description string Text description of the operation. + --device strings Identifies the target device on which this operation should be performed. (accepts pipeline) + -h, --help help for send + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --url string Url to the configuration. Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository +``` + +### Options inherited from parent commands + +``` + --abortOnErrors int Abort batch when reaching specified number of errors (default 10) + --allowEmptyPipe Don't fail when piped input is empty (stdin) + --cache Enable cached responses + --cacheBodyPaths strings Cache should limit hashing of selected paths in the json body. Empty indicates all values + --cacheTTL string Cache time-to-live (TTL) as a duration, i.e. 60s, 2m (default "60s") + -c, --compact Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal + --confirm Prompt for confirmation + --confirmText string Custom confirmation text + --currentPage int Current page which should be returned + --customQueryParam strings add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' + --debug Set very verbose log messages + --delay string delay after each request, i.e. 5ms, 1.2s (default "0ms") + --delayBefore string delay before each request, i.e. 5ms, 1.2s (default "0ms") + --dry Dry run. Don't send any data to the server + --dryFormat string Dry run output format. i.e. json, dump, markdown or curl (default "markdown") + --examples Show examples for the current command + --filter stringArray Apply a client side filter to response before returning it to the user + --flatten flatten json output by replacing nested json properties with properties where their names are represented by dot notation + -f, --force Do not prompt for confirmation. Ignored when using --confirm + -H, --header strings custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" + --includeAll Include all results by iterating through each page + -k, --insecure Allow insecure server connections when using SSL + -l, --logMessage string Add custom message to the activity log + --maxJobs int Maximum number of jobs. 0 = unlimited (use with caution!) + --noAccept Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect + --noCache Force disabling of cached responses (overwrites cache setting) + -M, --noColor Don't use colors when displaying log entries on the console + --noLog Disables the activity log for the current command + --noProgress Disable progress bars + --noProxy Ignore the proxy settings + -n, --nullInput Don't read the input (stdin). Useful if using in shell for/while loops + -o, --output string Output format i.e. table, json, csv, csvheader (default "table") + --outputFile string Save JSON output to file (after select/view) + --outputFileRaw string Save raw response to file (before select/view) + -p, --pageSize int Maximum results per page (default 5) + --progress Show progress bar. This will also disable any other verbose output + --proxy string Proxy setting, i.e. http://10.0.0.1:8080 + -r, --raw Show raw response. This mode will force output=json and view=off + --select stringArray Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' + --session string Session configuration + -P, --sessionPassword string Override session password + -U, --sessionUsername string Override session username. i.e. peter or t1234/peter (with tenant) + --silentExit Silent status codes do not affect the exit code + --silentStatusCodes string Status codes which will not print out an error message + --timeout string Request timeout duration, i.e. 60s, 2m (default "60s") + --totalPages int Total number of pages to get + -v, --verbose Verbose logging + --view string Use views when displaying data on the terminal. Disable using --view off (default "auto") + --withError Errors will be printed on stdout instead of stderr + --withTotalElements Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) + -t, --withTotalPages Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages + --workers int Number of workers (default 1) +``` + diff --git a/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_update.md b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_update.md index 5e417f502..382343268 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_update.md @@ -24,7 +24,7 @@ Update a configuration file ``` --configurationType string Configuration type - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the configuration package --deviceType string Device type filter. Only allow configuration to be applied to devices of this type --file string File to be uploaded diff --git a/docs/go-c8y-cli/docs/cli/c8y/currentapplication/c8y_currentapplication_update.md b/docs/go-c8y-cli/docs/cli/c8y/currentapplication/c8y_currentapplication_update.md index 653b528b1..3689ebe6e 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/currentapplication/c8y_currentapplication_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/currentapplication/c8y_currentapplication_update.md @@ -25,7 +25,7 @@ Update custom properties of the current application (requires using application ``` --availability string Application will be applied to this type of documents, possible values [ALARM, AUDIT, EVENT, MEASUREMENT, OPERATION, *]. --contextPath string contextPath of the hosted application - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --externalUrl string URL to the external application -h, --help help for update --key string Shared secret of application diff --git a/docs/go-c8y-cli/docs/cli/c8y/databroker/c8y_databroker_update.md b/docs/go-c8y-cli/docs/cli/c8y/databroker/c8y_databroker_update.md index 1ea3e1bec..02eef5ac3 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/databroker/c8y_databroker_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/databroker/c8y_databroker_update.md @@ -23,7 +23,7 @@ Change the status of a specific data broker connector by given connector id ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Data broker connector id (required) (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_create.md b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_create.md index ae25befb8..2023dca5c 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_create.md @@ -27,7 +27,7 @@ Create device group with custom properties ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --name string Device group name (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_update.md b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_update.md index f7778a2fd..71b94f550 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/c8y_devicegroups_update.md @@ -24,7 +24,7 @@ Update device group by id ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Device group ID (required) (accepts pipeline) --name string Device group name diff --git a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/children/c8y_devicegroups_children_create.md b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/children/c8y_devicegroups_children_create.md index 7df5e4887..0a4081a04 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devicegroups/children/c8y_devicegroups_children_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devicegroups/children/c8y_devicegroups_children_create.md @@ -24,7 +24,7 @@ Create a child addition and link it to an existing managed object ``` --childType string Child relationship type (required) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --global Enable global access to the managed object -h, --help help for create --id strings Managed object id where the child addition will be added to (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_create.md b/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_create.md index 99b2a3deb..41e555433 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_create.md @@ -28,7 +28,7 @@ Copy device certificates from one Cumulocity tenant to another (tenants must not ``` --autoRegistrationEnabled Enable auto registration - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string Certificate file (in PEM format with header/footer) -h, --help help for create --name string Certificate name (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_update.md b/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_update.md index e8db9d0f4..267b31a86 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devicemanagement/certificates/c8y_devicemanagement_certificates_update.md @@ -27,7 +27,7 @@ Update device certificate by name ``` --autoRegistrationEnabled Enable auto registration - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Certificate fingerprint or name (accepts pipeline) --name string Certificate name diff --git a/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_create.md b/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_create.md index 09a8ab66f..8e020a364 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_create.md @@ -23,7 +23,7 @@ Create a device profile ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --deviceType string Device type filter. Only allow device profile to be applied to devices of this type -h, --help help for create --name string name (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_update.md b/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_update.md index f570f03a0..aefd605a6 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/deviceprofiles/c8y_deviceprofiles_update.md @@ -23,7 +23,7 @@ Update a device profile ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --deviceType string Device type filter. Only allow device profile to be applied to devices of this type -h, --help help for update --id strings Device profile (managedObject) id (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_create.md b/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_create.md index d04cf3a3f..2f6ba106a 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_create.md @@ -27,7 +27,7 @@ Create device with custom properties ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --name string Device name (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_update.md b/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_update.md index f96b4ed05..f9b8ff654 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devices/c8y_devices_update.md @@ -15,15 +15,24 @@ c8y devices update [flags] ### Examples ``` -$ c8y devices update --id 12345 +$ c8y devices update --id 12345 --newName "MyDevice" Update device by id + +$ c8y devices update --id 12345 --template "{c8y_SupportedOperations:['c8y_Restart', 'c8y_Command']}" +Update device using a template + +$ c8y devices update --id 12345 --data "my.nested.number=1.234,my.nested.bool=true,my.nested.string=my name,my.nested.num_as_str='1.234'" +Update device using a data (with different formats) + +$ c8y devices update --id 12345 --data "myFragment=null" +Remove a property from a device by setting it to null ``` ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Device ID (required) (accepts pipeline) --newName string Device name diff --git a/docs/go-c8y-cli/docs/cli/c8y/devices/children/c8y_devices_children_create.md b/docs/go-c8y-cli/docs/cli/c8y/devices/children/c8y_devices_children_create.md index f6a558377..7f28efef9 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devices/children/c8y_devices_children_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devices/children/c8y_devices_children_create.md @@ -24,7 +24,7 @@ Create a child addition and link it to an existing managed object ``` --childType string Child relationship type (required) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --global Enable global access to the managed object -h, --help help for create --id strings Managed object id where the child addition will be added to (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_create.md b/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_create.md index 4c689066d..10eef8317 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_create.md @@ -23,7 +23,7 @@ Create a new service for a device (as a child addition) ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings Device id (required) (accepts pipeline) -h, --help help for create --name string Service name diff --git a/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_update.md b/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_update.md index 37daec9c8..00ac706e4 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/devices/services/c8y_devices_services_update.md @@ -26,7 +26,7 @@ Update service status ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings Device id (required for name lookup) -h, --help help for update --id strings Service id (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_create.md b/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_create.md index ea5620591..7b13a12da 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_create.md @@ -26,7 +26,7 @@ Create a new event for a device (using pipeline) ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The ManagedObject which is the source of this event. (accepts pipeline) -h, --help help for create --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_update.md b/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_update.md index 26be7f963..38eb244ab 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/events/c8y_events_update.md @@ -26,7 +26,7 @@ Update custom properties of an existing event ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Event id (required) (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_create.md b/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_create.md index b397b486b..c6d35778c 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_create.md @@ -26,7 +26,7 @@ Create the same firmware package for multiple device types ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the firmware package --deviceType string Device type filter. Only allow firmware to be applied to devices of this type (accepts pipeline) -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_update.md b/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_update.md index f6036eb33..f1f8cd710 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/firmware/c8y_firmware_update.md @@ -26,7 +26,7 @@ Update a firmware package name (using pipeline) ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the firmware package --deviceType string Device type filter. Only allow firmware to be applied to devices of this type -h, --help help for update diff --git a/docs/go-c8y-cli/docs/cli/c8y/firmware/patches/c8y_firmware_patches_create.md b/docs/go-c8y-cli/docs/cli/c8y/firmware/patches/c8y_firmware_patches_create.md index cbc9f500a..a34b9fb1e 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/firmware/patches/c8y_firmware_patches_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/firmware/patches/c8y_firmware_patches_create.md @@ -20,13 +20,16 @@ Create a new patch (with external URL) to an existing firmware version $ c8y firmware patches create --firmware custom\ firmware\ 1 --dependencyVersion 2.2.0 --version 2.2.1 --file ./install.ps1 Create a new patch (storing the file in Cumulocity) to an existing firmware version + +$ c8y firmware patches create --firmware 12345 --dependencyVersion 2.2.0 +Create a new patch with an empty version number and url ``` ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --dependencyVersion string Existing firmware version that the patch is dependent on --file string File to be uploaded --firmware strings Firmware package id where the version will be added to (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_create.md b/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_create.md index a1a8cb62b..e2902a1ee 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_create.md @@ -21,12 +21,15 @@ Create a new version using a binary file and link it to the existing "linux-os1" $ c8y firmware versions create --firmware "linux-os1" --version "1.0.0" --url "https://blob.azure.com/device-firmare/1.0.0/image.mender" Create a new version with an external URL and link it to the existing "linux-os1" firmware +$ c8y firmware versions create --firmware 12345 +Create a new version with an empty version number and url + ``` ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string File to be uploaded --firmware strings Firmware package id where the version will be added to (accepts pipeline) -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_install.md b/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_install.md index a5ff5c496..fdf984546 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_install.md +++ b/docs/go-c8y-cli/docs/cli/c8y/firmware/versions/c8y_firmware_versions_install.md @@ -28,7 +28,7 @@ Install a firmware version with an explicit url ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Operation description --device strings Device or agent where the firmware should be installed (accepts pipeline) --firmware string Firmware name (required) diff --git a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md index 21728c774..73e73cb3d 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/identity/c8y_identity_create.md @@ -26,7 +26,7 @@ Create an external identity by using the .name property of the device (via the i ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The ManagedObject linked to the external ID. (required) (accepts pipeline) -h, --help help for create --name string The identifier used in the external system that Cumulocity interfaces with. diff --git a/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_create.md b/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_create.md index e39b3d403..f2ffcf0e3 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_create.md @@ -23,7 +23,7 @@ Create a managed object ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --name string name (accepts pipeline) --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_update.md b/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_update.md index 3da0d5276..aec04a706 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/inventory/c8y_inventory_update.md @@ -17,13 +17,16 @@ c8y inventory update [flags] ``` $ c8y inventory update --id 12345 --newName "my_custom_name" --data "{\"com_my_props\":{},\"value\":1}" Update a managed object + +$ c8y inventory update --id 12345 --data "my_Fragment=null" +Remove a property (by setting it to null) ``` ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings ManagedObject id (required) (accepts pipeline) --newName string name diff --git a/docs/go-c8y-cli/docs/cli/c8y/inventory/children/c8y_inventory_children_create.md b/docs/go-c8y-cli/docs/cli/c8y/inventory/children/c8y_inventory_children_create.md index 76955914e..1a1b0bb61 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/inventory/children/c8y_inventory_children_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/inventory/children/c8y_inventory_children_create.md @@ -24,7 +24,7 @@ Create a child addition and link it to an existing managed object ``` --childType string Child relationship type (required) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --global Enable global access to the managed object -h, --help help for create --id strings Managed object id where the child addition will be added to (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_create.md b/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_create.md index b71b3f46e..0ccef3a05 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_create.md @@ -26,7 +26,7 @@ Copy measurements from one device to another ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The ManagedObject which is the source of this measurement. (accepts pipeline) -h, --help help for create --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_createBulk.md b/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_createBulk.md index e2b54ecda..b29959418 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_createBulk.md +++ b/docs/go-c8y-cli/docs/cli/c8y/measurements/c8y_measurements_createBulk.md @@ -36,7 +36,7 @@ Copy measurements from one device to another modifying the measurements slightly ``` --batchSize int Batch size. Number of measurements per request to send (default 10) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The ManagedObject which is the source of this measurement. (accepts pipeline) -h, --help help for createBulk --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_create.md b/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_create.md index 0888134a2..c143da0ac 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_create.md @@ -28,7 +28,7 @@ Create or update a microservice using an explicit name ``` --availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default) --contextPath string contextPath of the hosted application. Required when application type is HOSTED - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string Microservice file to be uploaded (or Cumulocity.json) file -h, --help help for create --key string Shared secret of application diff --git a/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_update.md b/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_update.md index 1840a967e..e7989803e 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/microservices/c8y_microservices_update.md @@ -26,7 +26,7 @@ Update microservice availability to MARKET ``` --availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default) --contextPath string contextPath of the hosted application - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id string Microservice id (required) (accepts pipeline) --key string Shared secret of microservice diff --git a/docs/go-c8y-cli/docs/cli/c8y/microservices/serviceusers/c8y_microservices_serviceusers_create.md b/docs/go-c8y-cli/docs/cli/c8y/microservices/serviceusers/c8y_microservices_serviceusers_create.md index ef7b14fbc..43ed1a096 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/microservices/serviceusers/c8y_microservices_serviceusers_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/microservices/serviceusers/c8y_microservices_serviceusers_create.md @@ -19,11 +19,11 @@ Create new application service user ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' - -h, --help help for create - --name string Name of application - --roles strings Roles which should be assigned to the service user - --tenants strings Tenant to subscribe to. If left blank than the application will not generate the service user + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -h, --help help for create + --name string Name of application + --roles strings Roles which should be assigned to the service user + --tenants strings Tenant to subscribe to. If left blank than the application will not generate the service user ``` ### Options inherited from parent commands diff --git a/docs/go-c8y-cli/docs/cli/c8y/notification2/subscriptions/c8y_notification2_subscriptions_create.md b/docs/go-c8y-cli/docs/cli/c8y/notification2/subscriptions/c8y_notification2_subscriptions_create.md index f395005d1..74fbb0f33 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/notification2/subscriptions/c8y_notification2_subscriptions_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/notification2/subscriptions/c8y_notification2_subscriptions_create.md @@ -33,7 +33,7 @@ Create a subscription which groups all devices in a single subscription name ``` --apiFilter strings Filter notifications by api --context string The context to which the subscription is associated. - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings The managed object to which the subscription is associated. (accepts pipeline) --fragmentsToCopy strings Transforms the data to only include specified custom fragments. Each custom fragment is identified by a unique name. If nothing is specified here, the data is forwarded as-is. -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/notification2/tokens/c8y_notification2_tokens_create.md b/docs/go-c8y-cli/docs/cli/c8y/notification2/tokens/c8y_notification2_tokens_create.md index 3f36efb18..c22058b28 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/notification2/tokens/c8y_notification2_tokens_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/notification2/tokens/c8y_notification2_tokens_create.md @@ -26,7 +26,7 @@ Create a new token which is valid for 30 minutes ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --expiresInMinutes int The token expiration duration. (default 1440) -h, --help help for create --name string The subscription name. This value must match the same that was used when the subscription was created. diff --git a/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_create.md b/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_create.md index 00fa093a6..f009f85b3 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_create.md @@ -23,7 +23,7 @@ Create operation for a device ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Text description of the operation. --device strings Identifies the target device on which this operation should be performed. (accepts pipeline) -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_update.md b/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_update.md index 867048679..117c55907 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/operations/c8y_operations_update.md @@ -24,7 +24,7 @@ Update an operation ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --failureReason string Reason for the failure. Use when setting status to FAILED -h, --help help for update --id strings Operation id (required) (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_create.md b/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_create.md index aa009203e..f2447c90f 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_create.md @@ -24,7 +24,7 @@ Create a retention rule ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --dataType string RetentionRule will be applied to this type of documents, possible values [ALARM, AUDIT, EVENT, MEASUREMENT, OPERATION, *]. (accepts pipeline) --editable Whether the rule is editable. Can be updated only by management tenant. --fragmentType string RetentionRule will be applied to documents with fragmentType. diff --git a/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_update.md b/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_update.md index 159397593..51ea8330f 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/retentionrules/c8y_retentionrules_update.md @@ -24,7 +24,7 @@ Update a retention rule ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --dataType string RetentionRule will be applied to this type of documents, possible values [ALARM, AUDIT, EVENT, MEASUREMENT, OPERATION, *]. --editable Whether the rule is editable. Can be updated only by management tenant. --fragmentType string RetentionRule will be applied to documents with fragmentType. diff --git a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_create.md b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_create.md index 99b7370b5..c7597689c 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_create.md @@ -29,12 +29,17 @@ $ c8y sessions create \ ### Example 3: Create a new production session where only only GET commands are enabled (with no password storage) $ c8y sessions create --type prod --host "https://mytenant.eu-latest.cumulocity.com" --noStorage + +### Example 4: Create a session which points to a local api endpoint (most like an Cumulocity IoT Edge instance) + +$ c8y sessions create --type prod --host "https://localhost:443" --insecure ``` ### Options ``` + --allowInsecure Allow insecure connection (e.g. when using self-signed certificates) --description string Description about the session --encrypt Encrypt passwords and tokens (occurs when logging in) -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_set.md b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_set.md index 5e8293513..60ce9833d 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_set.md +++ b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_set.md @@ -31,6 +31,7 @@ Set a session using a given file (non-interactively) ``` --clear Clear any existing tokens -h, --help help for set + --loginType string Login type preference, e.g. OAUTH2_INTERNAL or BASIC --sessionFilter string Filter to be applied to the list of sessions even before the values can be selected --shell string Shell type to return the environment variables --tfaCode string Two Factor Authentication code diff --git a/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_create.md b/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_create.md index 323e30328..0dbe50c15 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_create.md @@ -30,7 +30,7 @@ Create a smart group which is not visible in the UI ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for create --invisible Should the smart group be hidden from the user interface --name string Smart group name diff --git a/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_update.md b/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_update.md index fb18872a0..20734f6e6 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/smartgroups/c8y_smartgroups_update.md @@ -23,7 +23,7 @@ Update smart group by id ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Smart group ID (required) (accepts pipeline) --newName string New smart group name diff --git a/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_create.md b/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_create.md index 0fe0b1a8a..a461aae1a 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_create.md @@ -32,7 +32,7 @@ Create a software package and create a new version ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the software package --deviceType string Device type filter. Only allow software to be applied to devices of this type (accepts pipeline) -h, --help help for create diff --git a/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_update.md b/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_update.md index 10fe028dc..8576a90b5 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/software/c8y_software_update.md @@ -23,7 +23,7 @@ Update a software package ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Description of the software package --deviceType string Device type filter. Only allow software to be applied to devices of this type -h, --help help for update diff --git a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_create.md b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_create.md index 6255e2c6d..013dd2dac 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_create.md @@ -21,12 +21,15 @@ Create a new version using a binary file. The binary will be uploaded to Cumuloc $ c8y software versions create --software "my-app" --version "1.0.0" --url "https://" Create a new version with an external URL +$ c8y software versions create --software 12345 +Create a new version with an empty version number and url + ``` ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --file string File to be uploaded -h, --help help for create --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_install.md b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_install.md index a5b52811f..24032edaf 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_install.md +++ b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_install.md @@ -30,7 +30,7 @@ Install a software package version with an explicit url ``` --action string Software action (default "install") - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --description string Operation description (default "Install software package") --device strings Device or agent where the software should be installed (accepts pipeline) -h, --help help for install diff --git a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_uninstall.md b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_uninstall.md index bfb0c5304..7dbbc8539 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_uninstall.md +++ b/docs/go-c8y-cli/docs/cli/c8y/software/versions/c8y_software_versions_uninstall.md @@ -24,7 +24,7 @@ Uninstall a software package version ``` --action string Software action (default "delete") - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --device strings Device or agent where the software should be installed (accepts pipeline) -h, --help help for uninstall --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/template/c8y_template_execute.md b/docs/go-c8y-cli/docs/cli/c8y/template/c8y_template_execute.md index bd8419f88..0f1a14b5b 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/template/c8y_template_execute.md +++ b/docs/go-c8y-cli/docs/cli/c8y/template/c8y_template_execute.md @@ -36,7 +36,7 @@ Pass external json data into the template, and reference it via the "input.value ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for execute --input string input (accepts pipeline) --template string Body template diff --git a/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_updateBulk.md b/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_updateBulk.md index 88befce05..c80dfc8fa 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_updateBulk.md +++ b/docs/go-c8y-cli/docs/cli/c8y/tenantoptions/c8y_tenantoptions_updateBulk.md @@ -24,7 +24,7 @@ Update multiple tenant options ``` --category string Tenant Option category (required) (accepts pipeline) - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for updateBulk --processingMode string Cumulocity processing mode --template string Body template diff --git a/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_create.md b/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_create.md index 719bda17b..52a68b801 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_create.md @@ -28,7 +28,7 @@ Create a new tenant (from the management tenant) --company string Company name. Maximum 256 characters --contactName string A contact name, for example an administrator, of the tenant --contactPhone string An international contact phone number - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --domain string Domain name to be used for the tenant. Maximum 256 characters (accepts pipeline) -h, --help help for create --processingMode string Cumulocity processing mode diff --git a/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_update.md b/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_update.md index e01996925..6dae051d5 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/tenants/c8y_tenants_update.md @@ -28,7 +28,7 @@ Update a tenant by name (from the management tenant) --company string Company name. Maximum 256 characters --contactName string A contact name, for example an administrator, of the tenant --contactPhone string An international contact phone number - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --domain string Domain name to be used for the tenant. Maximum 256 characters -h, --help help for update --id string Tenant id (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_create.md b/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_create.md index 81501eb4c..a84956d67 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_create.md @@ -23,7 +23,7 @@ Create a user group ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --deviceProperties strings List of device permissions -h, --help help for create --name string Group name (accepts pipeline) diff --git a/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_update.md b/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_update.md index 874a0db16..3986f3bbd 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/usergroups/c8y_usergroups_update.md @@ -27,7 +27,7 @@ Update a user group with custom properties ### Options ``` - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' -h, --help help for update --id strings Group id (required) (accepts pipeline) --name string name diff --git a/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_create.md b/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_create.md index 2d46221c1..e973359ef 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_create.md +++ b/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_create.md @@ -28,7 +28,7 @@ Create a user using a template ``` --customProperties string Custom properties to be added to the user - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --email string User email address --enabled User activation status (true/false) --firstName string User first name diff --git a/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_update.md b/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_update.md index 67f7e8e59..0ebd2854f 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_update.md +++ b/docs/go-c8y-cli/docs/cli/c8y/users/c8y_users_update.md @@ -28,7 +28,7 @@ Update the email field in each user to match the id (if the id includes the @ si ``` --customProperties string Custom properties to be added to the user - -d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' + -d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' --email string User email address --enabled User activation status (true/false) --firstName string User first name diff --git a/docs/go-c8y-cli/docs/cli/psc8y/Configuration/Send-Configuration.md b/docs/go-c8y-cli/docs/cli/psc8y/Configuration/Send-Configuration.md new file mode 100644 index 000000000..50a7a6995 --- /dev/null +++ b/docs/go-c8y-cli/docs/cli/psc8y/Configuration/Send-Configuration.md @@ -0,0 +1,942 @@ +--- +category: Configuration +external help file: PSc8y-help.xml +id: Send-Configuration +Module Name: PSc8y +online version: https://reubenmiller.github.io/go-c8y-cli/docs/cli/c8y/configuration_send +schema: 2.0.0 +slug: /docs/cli/psc8y/Configuration/send-configuration +title: Send-Configuration +--- + + + +## SYNOPSIS +Send configuration to a device via an operation + +## SYNTAX + +``` +Send-Configuration + [[-Device] ] + [[-Description] ] + [[-ConfigurationType] ] + [[-Url] ] + [[-Configuration] ] + [-Data ] + [-NoAccept] + [-ProcessingMode ] + [-Force] + [-Template ] + [-TemplateVars ] + [-Raw] + [-OutputFile ] + [-OutputFileRaw ] + [-Proxy] + [-NoProxy] + [-Timeout ] + [-NoProgress] + [-Session ] + [-SessionUsername ] + [-SessionPassword ] + [-Output ] + [-View ] + [-AsHashTable] + [-AsPSObject] + [-Flatten] + [-Compact] + [-NoColor] + [-Cache] + [-NoCache] + [-CacheTTL ] + [-Insecure] + [-Help] + [-Examples] + [-Confirm] + [-ConfirmText ] + [-WithError] + [-SilentStatusCodes ] + [-SilentExit] + [-Dry] + [-DryFormat ] + [-Workers ] + [-Delay ] + [-DelayBefore ] + [-MaxJobs ] + [-Progress] + [-AbortOnErrors ] + [-NoLog] + [-LogMessage ] + [-Select ] + [-Filter ] + [-Header ] + [-CustomQueryParam ] + [] +``` + +## DESCRIPTION +Create a new operation to send configuration to an agent or device. + +If you provide the reference to the configuration (via id or name), then the configuration's +url and type will be automatically added to the operation. + +You may also manually set the url and configurationType rather than looking up the configuration +file in the configuration repository. + +## EXAMPLES + +### EXAMPLE 1 +``` +Send-Configuration -Device mydevice -Configuration 12345 +``` + +Send a configuration file to a device + +### EXAMPLE 2 +``` +Get-DeviceCollection | Send-Configuration -Configuration 12345 +``` + +Send a configuration file to multiple devices + +## PARAMETERS + +### -Device +Identifies the target device on which this operation should be performed. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Description +Text description of the operation. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationType +Configuration type. +Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +Url to the configuration. +Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +Configuration name or id + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AbortOnErrors +Abort batch when reaching specified number of errors + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsHashTable +Return output as PowerShell Hashtables + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsPSObject +Return output as PowerShell PSCustomObjects + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cache +Enable cached responses + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheTTL +Cache time-to-live (TTL) as a duration, i.e. +60s, 2m + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compact +Compact instead of pretty-printed output when using json output. +Pretty print is the default if output is the terminal + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Compress + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompt for confirmation + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfirmText +Custom confirmation text + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomQueryParam +add custom URL query parameters. +i.e. +--customQueryParam 'withCustomOption=true,myOtherOption=myvalue' + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Data +static data to be applied to body. +accepts json or shorthande json, i.e. +--data 'value1=1,my.nested.value=100' + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delay +delay after each request. +It accepts a duration, i.e. +1ms, 0.5s, 1m etc. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelayBefore +delay before each request. +It accepts a duration, i.e. +1ms, 0.5s, 1m etc. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dry +Dry run. +Don't send any data to the server + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DryFormat +Dry run output format. +i.e. +json, dump, markdown or curl + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Examples +Show examples for the current command + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Apply a client side filter to response before returning it to the user + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Flatten +flatten json output by replacing nested json properties with properties where their names are represented by dot notation + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not prompt for confirmation. +Ignored when using --confirm + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Header +custom headers. +i.e. +--header 'Accept: value, AnotherHeader: myvalue' + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Help +Show command help + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Insecure +Allow insecure server connections when using SSL + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogMessage +Add custom message to the activity log + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxJobs +Maximum number of jobs. +0 = unlimited (use with caution!) + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAccept +Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoCache +Force disabling of cached responses (overwrites cache setting) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoColor +Don't use colors when displaying log entries on the console + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoLog +Disables the activity log for the current command + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoProgress +Disable progress bars + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoProxy +Ignore the proxy settings + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Output +Output format i.e. +table, json, csv, csvheader + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Save JSON output to file (after select/view) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFileRaw +Save raw response to file (before select/view) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingMode +Cumulocity processing mode + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Progress +Show progress bar. +This will also disable any other verbose output + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +Proxy setting, i.e. +http://10.0.0.1:8080 + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Raw +Show raw response. +This mode will force output=json and view=off + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Comma separated list of properties to return. +wildcards and globstar accepted, i.e. +--select 'id,name,type,**.serialNumber' + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +Session configuration + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionPassword +Override session password + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionUsername +Override session username. +i.e. +peter or t1234/peter (with tenant) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SilentExit +Silent status codes do not affect the exit code + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SilentStatusCodes +Status codes which will not print out an error message + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Template +Body template + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateVars +Body template variables + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Request timeout. +It accepts a duration, i.e. +1ms, 0.5s, 1m etc. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -View +Use views when displaying data on the terminal. +Disable using --view off + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WithError +Errors will be printed on stdout instead of stderr + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workers +Number of workers + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[https://reubenmiller.github.io/go-c8y-cli/docs/cli/c8y/configuration_send](https://reubenmiller.github.io/go-c8y-cli/docs/cli/c8y/configuration_send) + diff --git a/docs/go-c8y-cli/docs/cli/psc8y/Sessions/New-Session.md b/docs/go-c8y-cli/docs/cli/psc8y/Sessions/New-Session.md index c081e4581..525f10d5d 100644 --- a/docs/go-c8y-cli/docs/cli/psc8y/Sessions/New-Session.md +++ b/docs/go-c8y-cli/docs/cli/psc8y/Sessions/New-Session.md @@ -25,6 +25,7 @@ New-Session [[-Name] ] [[-Description] ] [-NoTenantPrefix] + [-AllowInsecure] [] ``` @@ -157,6 +158,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowInsecure +Allow insecure connection (e.g. +when using self-signed certificates) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).