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 f9afdb6c1..830869dc2 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,13 +28,13 @@ 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' - -h, --help help for create - --name string Agent name (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string Agent 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' + -h, --help help for create + --name string Agent name (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string Agent type ``` ### Options inherited from parent commands 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 9af6fbfa1..2a3bf994a 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,13 +23,13 @@ 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' - -h, --help help for update - --id strings Agent ID (required) (accepts pipeline) - --newName string Agent name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -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 update + --id strings Agent ID (required) (accepts pipeline) + --newName string Agent name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 7f842b3f4..b3184c75e 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,17 +23,17 @@ 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' - --device strings The ManagedObject that the alarm originated from (accepts pipeline) - -h, --help help for create - --processingMode string Cumulocity processing mode - --severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. - --status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case. - --template string Body template - --templateVars string Body template variables - --text string Text description of the alarm. - --time string Time of the alarm. Defaults to current timestamp. - --type string Identifies the type of this alarm, e.g. 'com_cumulocity_events_TamperEvent'. + -d, --data string 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 + --severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. + --status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case. + --template string Body template + --templateVars stringArray Body template variables + --text string Text description of the alarm. + --time string Time of the alarm. Defaults to current timestamp. + --type string Identifies the type of this alarm, e.g. 'com_cumulocity_events_TamperEvent'. ``` ### Options inherited from parent commands 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 3c7f4b0cf..736b6b586 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,15 +26,15 @@ 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' - -h, --help help for update - --id strings Alarm id (required) (accepts pipeline) - --processingMode string Cumulocity processing mode - --severity string Alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING. - --status string The status of the alarm. If not specified, a new alarm will be created as ACTIVE. - --template string Body template - --templateVars string Body template variables - --text string Text description of the alarm. + -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 update + --id strings Alarm id (required) (accepts pipeline) + --processingMode string Cumulocity processing mode + --severity string Alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING. + --status string The status of the alarm. If not specified, a new alarm will be created as ACTIVE. + --template string Body template + --templateVars stringArray Body template variables + --text string Text description of the alarm. ``` ### Options inherited from parent commands 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 4114d0e17..41dc9167d 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 @@ -23,20 +23,20 @@ Update the status of all active alarms on a device to ACKNOWLEDGED ### Options ``` - --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' - --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) - -h, --help help for updateCollection - --newStatus string New status to be applied to all of the matching alarms - --processingMode string Cumulocity processing mode - --resolved When set to true only resolved alarms will be removed (the one with status CLEARED), false means alarms with status ACTIVE or ACKNOWLEDGED. - --severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. - --status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case. - --template string Body template - --templateVars string Body template variables + --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' + --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) + -h, --help help for updateCollection + --newStatus string New status to be applied to all of the matching alarms + --processingMode string Cumulocity processing mode + --resolved When set to true only resolved alarms will be removed (the one with status CLEARED), false means alarms with status ACTIVE or ACKNOWLEDGED. + --severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. + --status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case. + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 fabb17002..79fc877ca 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 @@ -45,18 +45,18 @@ a template to also build the request's body from the piped input data. ### Options ``` - --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' - --file string File to be uploaded as a binary - --formdata string form data (json or shorthand json) - -h, --help help for api - --host string host to use for the rest request. If empty, then the session's host will be used - --keepProperties Don't strip Cumulocity properties from the data property, i.e. source etc. (default true) - --method string HTTP method (default "GET") - --template string Body template - --templateVars string Body template variables - --url string URL path. Any reference to '%s' will be replaced with the current input value (accepts pipeline) + --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' + --file string File to be uploaded as a binary + --formdata string form data (json or shorthand json) + -h, --help help for api + --host string host to use for the rest request. If empty, then the session's host will be used + --keepProperties Don't strip Cumulocity properties from the data property, i.e. source etc. (default true) + --method string HTTP method (default "GET") + --template string Body template + --templateVars stringArray Body template variables + --url string URL path. Any reference to '%s' will be replaced with the current input value (accepts pipeline) ``` ### Options inherited from parent commands 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 6c3904e7a..f662f5ce4 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 @@ -35,7 +35,7 @@ Create a new hosted application --resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED --resourcesUsername string authorization username to access resourcesUrl --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables --type string Type of application. Possible values are EXTERNAL, HOSTED, MICROSERVICE ``` 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 eb9f2f19d..1e2f2e4e5 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 @@ -32,18 +32,18 @@ Create/update hosted web application but don't activate it, so the current versi ### Options ``` - --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' - --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) - --name string Name of application - --resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED (default "/") - --skipActivation Don't activate to the application after it has been created and uploaded - --skipUpload Don't uploaded the web app binary. Only the application placeholder will be created - --template string Body template - --templateVars string Body template variables + --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' + --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) + --name string Name of application + --resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED (default "/") + --skipActivation Don't activate to the application after it has been created and uploaded + --skipUpload Don't uploaded the web app binary. Only the application placeholder will be created + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 e3b79a30d..da8a31fdd 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 @@ -36,7 +36,7 @@ Update application availability to MARKET --resourcesUrl string URL to application base directory hosted on an external server --resourcesUsername string authorization username to access resourcesUrl --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 8815be9db..fafb09da8 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 @@ -23,19 +23,19 @@ Create an audit record for a custom managed object update ### Options ``` - --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' - -h, --help help for create - --processingMode string Cumulocity processing mode - --severity string The severity of action: critical, major, minor, warning or information. - --source string An optional ManagedObject that the audit record originated from (accepts pipeline) - --template string Body template - --templateVars string Body template variables - --text string Text description of the audit record. - --time string Time of the audit record. Defaults to current timestamp. - --type string Identifies the type of this audit record. - --user string The user responsible for the audited action. + --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' + -h, --help help for create + --processingMode string Cumulocity processing mode + --severity string The severity of action: critical, major, minor, warning or information. + --source string An optional ManagedObject that the audit record originated from (accepts pipeline) + --template string Body template + --templateVars stringArray Body template variables + --text string Text description of the audit record. + --time string Time of the audit record. Defaults to current timestamp. + --type string Identifies the type of this audit record. + --user string The user responsible for the audited action. ``` ### Options inherited from parent commands 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 e79b3df83..44696d1c7 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,14 +30,14 @@ 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' - --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 - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string Custom type. If left blank, the MIME type will be detected from the file extension + -d, --data string 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 + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string Custom type. If left blank, the MIME type will be detected from the file extension ``` ### Options inherited from parent commands 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 cc019fffc..a11ebc259 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 @@ -26,15 +26,15 @@ Create bulk operation for a group (using pipeline) ### Options ``` - --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' - --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 - --processingMode string Cumulocity processing mode - --startDate string Time when operations should be created. Defaults to 300s - --template string Body template - --templateVars string Body template variables + --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' + --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 + --processingMode string Cumulocity processing mode + --startDate string Time when operations should be created. Defaults to 300s + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 517017a9b..1e852170d 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 @@ -23,13 +23,13 @@ Update an bulk operation ### Options ``` - --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' - -h, --help help for update - --id strings Bulk Operation id (required) (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --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' + -h, --help help for update + --id strings Bulk Operation id (required) (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 40624adeb..d9274e69f 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 @@ -38,7 +38,7 @@ available for multiple device types --name string name --processingMode string Cumulocity processing mode --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables --url string URL link to the configuration file ``` 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 4d922c7ea..5e417f502 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 @@ -33,7 +33,7 @@ Update a configuration file --newName string New configuration name --processingMode string Cumulocity processing mode --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables --url string URL link to the configuration file ``` 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 a9902952d..653b528b1 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 @@ -35,7 +35,7 @@ Update custom properties of the current application (requires using application --resourcesUrl string URL to application base directory hosted on an external server --resourcesUsername string authorization username to access resourcesUrl --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 71a3a7614..1ea3e1bec 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,13 +23,13 @@ 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' - -h, --help help for update - --id strings Data broker connector id (required) (accepts pipeline) - --processingMode string Cumulocity processing mode - --status string DataBroker status [SUSPENDED]. - --template string Body template - --templateVars string Body template variables + -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 update + --id strings Data broker connector id (required) (accepts pipeline) + --processingMode string Cumulocity processing mode + --status string DataBroker status [SUSPENDED]. + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 c2e780db7..ae25befb8 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,13 +27,13 @@ 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' - -h, --help help for create - --name string Device group name (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string Device group type (c8y_DeviceGroup (root folder) or c8y_DeviceSubGroup (sub folder)). Defaults to c8y_DeviceGroup + -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 Device group name (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string Device group type (c8y_DeviceGroup (root folder) or c8y_DeviceSubGroup (sub folder)). Defaults to c8y_DeviceGroup ``` ### Options inherited from parent commands 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 3fd596788..f7778a2fd 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,13 +24,13 @@ 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' - -h, --help help for update - --id strings Device group ID (required) (accepts pipeline) - --name string Device group name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -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 update + --id strings Device group ID (required) (accepts pipeline) + --name string Device group name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 cf5f0b062..7df5e4887 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 @@ -23,14 +23,14 @@ Create a child addition and link it to an existing managed object ### Options ``` - --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' - --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) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --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' + --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) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 029c2f1c0..99b2a3deb 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 @@ -27,16 +27,16 @@ Copy device certificates from one Cumulocity tenant to another (tenants must not ### Options ``` - --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' - --file string Certificate file (in PEM format with header/footer) - -h, --help help for create - --name string Certificate name (accepts pipeline) - --processingMode string Cumulocity processing mode - --status string Status (default "ENABLED") - --template string Body template - --templateVars string Body template variables - --tenant string Tenant id + --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' + --file string Certificate file (in PEM format with header/footer) + -h, --help help for create + --name string Certificate name (accepts pipeline) + --processingMode string Cumulocity processing mode + --status string Status (default "ENABLED") + --template string Body template + --templateVars stringArray Body template variables + --tenant string Tenant id ``` ### Options inherited from parent commands 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 b4e1034af..e8db9d0f4 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 @@ -26,16 +26,16 @@ Update device certificate by name ### Options ``` - --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' - -h, --help help for update - --id strings Certificate fingerprint or name (accepts pipeline) - --name string Certificate name - --processingMode string Cumulocity processing mode - --status string Status - --template string Body template - --templateVars string Body template variables - --tenant string Tenant id + --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' + -h, --help help for update + --id strings Certificate fingerprint or name (accepts pipeline) + --name string Certificate name + --processingMode string Cumulocity processing mode + --status string Status + --template string Body template + --templateVars stringArray Body template variables + --tenant string Tenant id ``` ### Options inherited from parent commands 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 acd14e394..09a8ab66f 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,13 +23,13 @@ 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' - --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) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 ba0561de5..f570f03a0 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,14 +23,14 @@ 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' - --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) - --newName string New device profile name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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) + --newName string New device profile name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 1ff5389d6..d04cf3a3f 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,13 +27,13 @@ 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' - -h, --help help for create - --name string Device name (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string Device 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' + -h, --help help for create + --name string Device name (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string Device type ``` ### Options inherited from parent commands 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 a5e54b0d6..f96b4ed05 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 @@ -23,13 +23,13 @@ Update device 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' - -h, --help help for update - --id strings Device ID (required) (accepts pipeline) - --newName string Device name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -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 update + --id strings Device ID (required) (accepts pipeline) + --newName string Device name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 fc637b9cc..f6a558377 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 @@ -23,14 +23,14 @@ Create a child addition and link it to an existing managed object ### Options ``` - --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' - --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) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --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' + --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) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 70e1ad574..4c689066d 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,16 +23,16 @@ 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' - --device strings Device id (required) (accepts pipeline) - -h, --help help for create - --name string Service name - --processingMode string Cumulocity processing mode - --serviceType string Service type, e.g. systemd - --status string Service status - --template string Body template - --templateVars string Body template variables - --type string 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' + --device strings Device id (required) (accepts pipeline) + -h, --help help for create + --name string Service name + --processingMode string Cumulocity processing mode + --serviceType string Service type, e.g. systemd + --status string Service status + --template string Body template + --templateVars stringArray Body template variables + --type string type ``` ### Options inherited from parent commands 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 3e4e4e9d0..37daec9c8 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,16 +26,16 @@ 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' - --device strings Device id (required for name lookup) - -h, --help help for update - --id strings Service id (required) (accepts pipeline) - --name string Service name - --processingMode string Cumulocity processing mode - --serviceType string Service type, e.g. systemd - --status string Service status - --template string Body template - --templateVars string Body template variables + -d, --data string 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) + --name string Service name + --processingMode string Cumulocity processing mode + --serviceType string Service type, e.g. systemd + --status string Service status + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 d606bf963..ea5620591 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,15 +26,15 @@ 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' - --device strings The ManagedObject which is the source of this event. (accepts pipeline) - -h, --help help for create - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --text string Text description of the event. - --time string Time of the event. Defaults to current timestamp. - --type string Identifies the type of this event. + -d, --data string 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 + --template string Body template + --templateVars stringArray Body template variables + --text string Text description of the event. + --time string Time of the event. Defaults to current timestamp. + --type string Identifies the type of this event. ``` ### Options inherited from parent commands 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 ede20bcfd..26be7f963 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,13 +26,13 @@ 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' - -h, --help help for update - --id strings Event id (required) (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --text string Text description of the event. + -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 update + --id strings Event id (required) (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --text string Text description of the event. ``` ### Options inherited from parent commands 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 149e692cf..b397b486b 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,14 +26,14 @@ 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' - --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 - --name string name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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 + --name string name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 f1b4b4590..f6036eb33 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,15 +26,15 @@ 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' - --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 - --id strings Firmware package (managedObject) id (required) (accepts pipeline) - --newName string New firmware package name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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 + --id strings Firmware package (managedObject) id (required) (accepts pipeline) + --newName string New firmware package name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 474f354c8..cbc9f500a 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 @@ -33,7 +33,7 @@ Create a new patch (storing the file in Cumulocity) to an existing firmware vers -h, --help help for create --processingMode string Cumulocity processing mode --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables --url string URL to the firmware patch --version string Patch version, i.e. 1.0.0 ``` 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 fdb7f52e4..a1a8cb62b 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 @@ -26,15 +26,15 @@ Create a new version with an external URL and link it to the existing "linux-os1 ### 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' - --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 - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --url string URL to the firmware package - --version string Version name, i.e. 1.0.0. If left blank than the version + -d, --data string 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 + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --url string URL to the firmware package + --version string Version name, i.e. 1.0.0. If left blank than the version ``` ### Options inherited from parent commands 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 4918623b5..a5ff5c496 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,16 +28,16 @@ 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' - --description string Operation description - --device strings Device or agent where the firmware should be installed (accepts pipeline) - --firmware string Firmware name (required) - -h, --help help for install - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --url string Firmware url. Leave blank to automatically set it if a matching firmware/version is found in the c8y firmware repository - --version string Firmware version + -d, --data string 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) + -h, --help help for install + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --url string Firmware url. Leave blank to automatically set it if a matching firmware/version is found in the c8y firmware repository + --version string Firmware version ``` ### Options inherited from parent commands 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 6d9e1a148..21728c774 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,14 +26,14 @@ 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' - --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. - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string The type of the external identifier as string, e.g. 'com_cumulocity_model_idtype_SerialNumber'. + -d, --data string 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. + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string The type of the external identifier as string, e.g. 'com_cumulocity_model_idtype_SerialNumber'. ``` ### Options inherited from parent commands 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 59aef6d47..e39b3d403 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,13 +23,13 @@ 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' - -h, --help help for create - --name string name (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --type string 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' + -h, --help help for create + --name string name (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --type string type ``` ### Options inherited from parent commands 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 0a358de48..3da0d5276 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 @@ -23,13 +23,13 @@ Update 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' - -h, --help help for update - --id strings ManagedObject id (required) (accepts pipeline) - --newName string name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -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 update + --id strings ManagedObject id (required) (accepts pipeline) + --newName string name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 67bef96f9..76955914e 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 @@ -23,14 +23,14 @@ Create a child addition and link it to an existing managed object ### Options ``` - --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' - --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) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --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' + --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) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 68241ee3e..b71b3f46e 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,14 +26,14 @@ 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' - --device strings The ManagedObject which is the source of this measurement. (accepts pipeline) - -h, --help help for create - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --time string Time of the measurement. Defaults to current timestamp. - --type string The most specific type of this entire measurement. + -d, --data string 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 + --template string Body template + --templateVars stringArray Body template variables + --time string Time of the measurement. Defaults to current timestamp. + --type string The most specific type of this entire measurement. ``` ### Options inherited from parent commands 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 9f8b8d5b1..e2b54ecda 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 @@ -35,15 +35,15 @@ Copy measurements from one device to another modifying the measurements slightly ### Options ``` - --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' - --device strings The ManagedObject which is the source of this measurement. (accepts pipeline) - -h, --help help for createBulk - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --time string Time of the measurement. Defaults to current timestamp. - --type string The most specific type of this entire measurement. + --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' + --device strings The ManagedObject which is the source of this measurement. (accepts pipeline) + -h, --help help for createBulk + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --time string Time of the measurement. Defaults to current timestamp. + --type string The most specific type of this entire measurement. ``` ### Options inherited from parent commands 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 4c1aeb4d2..0888134a2 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 @@ -26,19 +26,19 @@ Create or update a microservice using an explicit name ### Options ``` - --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' - --file string Microservice file to be uploaded (or Cumulocity.json) file - -h, --help help for create - --key string Shared secret of application - --name string Name of application - --processingMode string Cumulocity processing mode - --resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED - --skipSubscription Skip microservice subscription when creating the new microservice - --skipUpload Skip uploading the binary to the platform - --template string Body template - --templateVars string Body template variables + --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' + --file string Microservice file to be uploaded (or Cumulocity.json) file + -h, --help help for create + --key string Shared secret of application + --name string Name of application + --processingMode string Cumulocity processing mode + --resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED + --skipSubscription Skip microservice subscription when creating the new microservice + --skipUpload Skip uploading the binary to the platform + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 8eb182031..1840a967e 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 @@ -24,16 +24,16 @@ Update microservice availability to MARKET ### Options ``` - --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' - -h, --help help for update - --id string Microservice id (required) (accepts pipeline) - --key string Shared secret of microservice - --processingMode string Cumulocity processing mode - --resourcesUrl string URL to microservice base directory hosted on an external server - --template string Body template - --templateVars string Body template variables + --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' + -h, --help help for update + --id string Microservice id (required) (accepts pipeline) + --key string Shared secret of microservice + --processingMode string Cumulocity processing mode + --resourcesUrl string URL to microservice base directory hosted on an external server + --template string Body template + --templateVars stringArray Body template variables ``` ### 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 579dc9a05..f395005d1 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 @@ -31,17 +31,17 @@ Create a subscription which groups all devices in a single subscription name ### Options ``` - --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' - --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 - --name string The subscription name. Each subscription is identified by a unique name within a specific context. - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --typeFilter string The data needs to have the specified value in its type property to meet the filter criteria. + --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' + --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 + --name string The subscription name. Each subscription is identified by a unique name within a specific context. + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --typeFilter string The data needs to have the specified value in its type property to meet the filter criteria. ``` ### Options inherited from parent commands 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 9f13f1a4b..3f36efb18 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,15 +26,15 @@ 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' - --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. - --processingMode string Cumulocity processing mode - --shared string Subscription is shared amongst multiple subscribers - --subscriber string The subscriber name which the client wishes to be identified with. (accepts pipeline) - --template string Body template - --templateVars string Body template variables + -d, --data string 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. + --processingMode string Cumulocity processing mode + --shared string Subscription is shared amongst multiple subscribers + --subscriber string The subscriber name which the client wishes to be identified with. (accepts pipeline) + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 364fed5ef..00fa093a6 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,13 +23,13 @@ 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' - --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 - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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 + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 6f283d728..867048679 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,14 +24,14 @@ 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' - --failureReason string Reason for the failure. Use when setting status to FAILED - -h, --help help for update - --id strings Operation id (required) (accepts pipeline) - --processingMode string Cumulocity processing mode - --status string Operation status, can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING. - --template string Body template - --templateVars string Body template variables + -d, --data string 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) + --processingMode string Cumulocity processing mode + --status string Operation status, can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING. + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 72fdf99a7..aa009203e 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,17 +24,17 @@ 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' - --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. - -h, --help help for create - --maximumAge int Maximum age of document in days. - --processingMode string Cumulocity processing mode - --source string RetentionRule will be applied to documents with source. - --template string Body template - --templateVars string Body template variables - --type string RetentionRule will be applied to documents with 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' + --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. + -h, --help help for create + --maximumAge int Maximum age of document in days. + --processingMode string Cumulocity processing mode + --source string RetentionRule will be applied to documents with source. + --template string Body template + --templateVars stringArray Body template variables + --type string RetentionRule will be applied to documents with type. ``` ### Options inherited from parent commands 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 ad52f91ee..159397593 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,18 +24,18 @@ 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' - --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. - -h, --help help for update - --id strings Retention rule id (required) (accepts pipeline) - --maximumAge int Maximum age of document in days. - --processingMode string Cumulocity processing mode - --source string RetentionRule will be applied to documents with source. - --template string Body template - --templateVars string Body template variables - --type string RetentionRule will be applied to documents with 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' + --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. + -h, --help help for update + --id strings Retention rule id (required) (accepts pipeline) + --maximumAge int Maximum age of document in days. + --processingMode string Cumulocity processing mode + --source string RetentionRule will be applied to documents with source. + --template string Body template + --templateVars stringArray Body template variables + --type string RetentionRule will be applied to documents with type. ``` ### Options inherited from parent commands diff --git a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_encryptText.md b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_encryptText.md index adc329b7c..979b48bae 100644 --- a/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_encryptText.md +++ b/docs/go-c8y-cli/docs/cli/c8y/sessions/c8y_sessions_encryptText.md @@ -34,6 +34,7 @@ Password: {encrypted}ec5b837a03408ffb731307584eac40ac047989a002951e4b7139fa60189 ``` -h, --help help for encryptText --passphrase string Passphrase use for encrypting the text + --raw Only return the encrypted text and nothing else --text string Text to be encrypted. (required) ``` @@ -77,7 +78,6 @@ Password: {encrypted}ec5b837a03408ffb731307584eac40ac047989a002951e4b7139fa60189 -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 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 e5fb09f4c..323e30328 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,14 +30,14 @@ 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' - -h, --help help for create - --invisible Should the smart group be hidden from the user interface - --name string Smart group name - --processingMode string Cumulocity processing mode - --query string Smart group query. Should be a valid inventory query. i.e. "name eq 'myname' and has(myFragment)" (accepts pipeline) - --template string Body template - --templateVars string Body template variables + -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 + --invisible Should the smart group be hidden from the user interface + --name string Smart group name + --processingMode string Cumulocity processing mode + --query string Smart group query. Should be a valid inventory query. i.e. "name eq 'myname' and has(myFragment)" (accepts pipeline) + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 5645a4d16..fb18872a0 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,14 +23,14 @@ 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' - -h, --help help for update - --id strings Smart group ID (required) (accepts pipeline) - --newName string New smart group name - --processingMode string Cumulocity processing mode - --query string New query - --template string Body template - --templateVars string Body template variables + -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 update + --id strings Smart group ID (required) (accepts pipeline) + --newName string New smart group name + --processingMode string Cumulocity processing mode + --query string New query + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 6a3fecbf1..0fe0b1a8a 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,14 +32,14 @@ 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' - --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 - --name string name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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 + --name string name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 f835f446c..10fe028dc 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,15 +23,15 @@ 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' - --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 - --id strings Software package (managedObject) id (required) (accepts pipeline) - --newName string New software package name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + -d, --data string 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 + --id strings Software package (managedObject) id (required) (accepts pipeline) + --newName string New software package name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 9ea7e0e86..6255e2c6d 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 @@ -26,15 +26,15 @@ Create a new version with an external 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' - --file string File to be uploaded - -h, --help help for create - --processingMode string Cumulocity processing mode - --software strings Software package id where the version will be added to (accepts pipeline) - --template string Body template - --templateVars string Body template variables - --url string URL to the software package - --version string Software package version name, i.e. 1.0.0 + -d, --data string 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 + --software strings Software package id where the version will be added to (accepts pipeline) + --template string Body template + --templateVars stringArray Body template variables + --url string URL to the software package + --version string Software package version name, i.e. 1.0.0 ``` ### Options inherited from parent commands 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 328f7cef4..a5b52811f 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 @@ -29,17 +29,17 @@ Install a software package version with an explicit url ### Options ``` - --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' - --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 - --processingMode string Cumulocity processing mode - --software string Software name (required) - --template string Body template - --templateVars string Body template variables - --url string Software url. Leave blank to automatically set it if a matching firmware/version is found in the c8y firmware repository - --version string Software version id or name + --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' + --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 + --processingMode string Cumulocity processing mode + --software string Software name (required) + --template string Body template + --templateVars stringArray Body template variables + --url string Software url. Leave blank to automatically set it if a matching firmware/version is found in the c8y firmware repository + --version string Software version id or name ``` ### Options inherited from parent commands 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 57a79ec18..bfb0c5304 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 @@ -23,15 +23,15 @@ Uninstall a software package version ### Options ``` - --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' - --device strings Device or agent where the software should be installed (accepts pipeline) - -h, --help help for uninstall - --processingMode string Cumulocity processing mode - --software string Software name (required) - --template string Body template - --templateVars string Body template variables - --version string Software version name or id + --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' + --device strings Device or agent where the software should be installed (accepts pipeline) + -h, --help help for uninstall + --processingMode string Cumulocity processing mode + --software string Software name (required) + --template string Body template + --templateVars stringArray Body template variables + --version string Software version name or id ``` ### Options inherited from parent commands 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 4b9f80072..bd8419f88 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,11 +36,11 @@ 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' - -h, --help help for execute - --input string input (accepts pipeline) - --template string Body template - --templateVars string Body template variables + -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 execute + --input string input (accepts pipeline) + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 b1957b14b..88befce05 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 @@ -23,12 +23,12 @@ Update multiple tenant options ### 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' - -h, --help help for updateBulk - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --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' + -h, --help help for updateBulk + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 5ebfdf203..719bda17b 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 @@ -23,18 +23,18 @@ Create a new tenant (from the management tenant) ### Options ``` - --adminName string Username of the tenant administrator - --adminPass string Password of the tenant administrator - --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' - --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 - --template string Body template - --templateVars string Body template variables - --tenantId string The tenant ID. This should be left bank unless you know what you are doing. Will be auto-generated if not present. + --adminName string Username of the tenant administrator + --adminPass string Password of the tenant administrator + --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' + --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 + --template string Body template + --templateVars stringArray Body template variables + --tenantId string The tenant ID. This should be left bank unless you know what you are doing. Will be auto-generated if not present. ``` ### Options inherited from parent commands 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 6b093d84e..e01996925 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 @@ -23,18 +23,18 @@ Update a tenant by name (from the management tenant) ### Options ``` - --adminName string Username of the tenant administrator - --adminPass string Password of the tenant administrator - --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' - --domain string Domain name to be used for the tenant. Maximum 256 characters - -h, --help help for update - --id string Tenant id (accepts pipeline) - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables + --adminName string Username of the tenant administrator + --adminPass string Password of the tenant administrator + --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' + --domain string Domain name to be used for the tenant. Maximum 256 characters + -h, --help help for update + --id string Tenant id (accepts pipeline) + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables ``` ### Options inherited from parent commands 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 d08888df1..81501eb4c 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 @@ -29,7 +29,7 @@ Create a user group --name string Group name (accepts pipeline) --processingMode string Cumulocity processing mode --template string Body template - --templateVars string Body template variables + --templateVars stringArray Body template variables --tenant string Tenant ``` 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 d33460b06..874a0db16 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,14 +27,14 @@ 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' - -h, --help help for update - --id strings Group id (required) (accepts pipeline) - --name string name - --processingMode string Cumulocity processing mode - --template string Body template - --templateVars string Body template variables - --tenant string Tenant + -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 update + --id strings Group id (required) (accepts pipeline) + --name string name + --processingMode string Cumulocity processing mode + --template string Body template + --templateVars stringArray Body template variables + --tenant string Tenant ``` ### Options inherited from parent commands 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 ebad5e499..2d46221c1 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 @@ -27,21 +27,21 @@ Create a user using a template ### Options ``` - --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' - --email string User email address - --enabled User activation status (true/false) - --firstName string User first name - -h, --help help for create - --lastName string User last name - --password string User password. Min: 6, max: 32 characters. Only Latin1 chars allowed - --phone string User phone number. Format: '+[country code][number]', has to be a valid MSISDN - --processingMode string Cumulocity processing mode - --sendPasswordResetEmail Send password reset email to the user instead of setting a password - --template string Body template - --templateVars string Body template variables - --tenant string Tenant - --userName string User name, unique for a given domain. Max: 1000 characters (accepts pipeline) + --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' + --email string User email address + --enabled User activation status (true/false) + --firstName string User first name + -h, --help help for create + --lastName string User last name + --password string User password. Min: 6, max: 32 characters. Only Latin1 chars allowed + --phone string User phone number. Format: '+[country code][number]', has to be a valid MSISDN + --processingMode string Cumulocity processing mode + --sendPasswordResetEmail Send password reset email to the user instead of setting a password + --template string Body template + --templateVars stringArray Body template variables + --tenant string Tenant + --userName string User name, unique for a given domain. Max: 1000 characters (accepts pipeline) ``` ### Options inherited from parent commands 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 20b12e806..67f7e8e59 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 @@ -27,21 +27,21 @@ Update the email field in each user to match the id (if the id includes the @ si ### Options ``` - --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' - --email string User email address - --enabled User activation status (true/false) - --firstName string User first name - -h, --help help for update - --id strings User id (required) (accepts pipeline) - --lastName string User last name - --password string User password. Min: 6, max: 32 characters. Only Latin1 chars allowed - --phone string User phone number. Format: '+[country code][number]', has to be a valid MSISDN - --processingMode string Cumulocity processing mode - --sendPasswordResetEmail Send password reset email to the user instead of setting a password - --template string Body template - --templateVars string Body template variables - --tenant string Tenant + --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' + --email string User email address + --enabled User activation status (true/false) + --firstName string User first name + -h, --help help for update + --id strings User id (required) (accepts pipeline) + --lastName string User last name + --password string User password. Min: 6, max: 32 characters. Only Latin1 chars allowed + --phone string User phone number. Format: '+[country code][number]', has to be a valid MSISDN + --processingMode string Cumulocity processing mode + --sendPasswordResetEmail Send password reset email to the user instead of setting a password + --template string Body template + --templateVars stringArray Body template variables + --tenant string Tenant ``` ### Options inherited from parent commands