Skip to content

Commit

Permalink
update cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
reubenmiller committed Nov 26, 2022
1 parent 799be4d commit de13b50
Show file tree
Hide file tree
Showing 71 changed files with 1,167 additions and 71 deletions.
2 changes: 1 addition & 1 deletion docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Create agent with custom properties
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--name string Agent name (accepts pipeline)
--processingMode string Cumulocity processing mode
Expand Down
2 changes: 1 addition & 1 deletion docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Update agent by id
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Agent ID (required) (accepts pipeline)
--newName string Agent name
Expand Down
2 changes: 1 addition & 1 deletion docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Create a new alarm for device
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
-h, --help help for create
--processingMode string Cumulocity processing mode
Expand Down
2 changes: 1 addition & 1 deletion docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Update severity of an existing alarm to CRITICAL
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Alarm id (required) (accepts pipeline)
--processingMode string Cumulocity processing mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Update the status of all active alarms on a device to ACKNOWLEDGED
```
--createdFrom string Start date or date and time of the alarm creation. Version >= 10.11
--createdTo string End date or date and time of the alarm creation. Version >= 10.11
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--dateFrom string Start date or date and time of alarm occurrence.
--dateTo string End date or date and time of alarm occurrence.
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
Expand Down
2 changes: 1 addition & 1 deletion docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ a template to also build the request's body from the piped input data.
```
--accept string accept (header)
--contentType string content type (header)
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary
--formdata string form data (json or shorthand json)
-h, --help help for api
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create a new hosted application
```
--availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default)
--contextPath string contextPath of the hosted application. Required when application type is HOSTED
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--externalUrl string URL to the external application. Required when application type is EXTERNAL
-h, --help help for create
--key string Shared secret of application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Create/update hosted web application but don't activate it, so the current versi
```
--availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default)
--contextPath string contextPath of the hosted application
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File or Folder of the web application. It should contain a index.html file in the root folder/ or zip file
-h, --help help for createHostedApplication
--key string Shared secret of application. Defaults to the value inside the cumulocity.json file (if present)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Update application availability to MARKET
```
--availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default)
--contextPath string contextPath of the hosted application
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--externalUrl string URL to the external application
-h, --help help for update
--id string Application id (required) (accepts pipeline)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create an audit record for a custom managed object update
```
--activity string The activity that was carried out.
--application string The application used to carry out the audited action.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--processingMode string Cumulocity processing mode
--severity string The severity of action: critical, major, minor, warning or information.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Upload a file with a custom name and custom meta information
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary (required)
-h, --help help for create
--name string Set the name of the binary file. This will be the name of the file when it is downloaded in the UI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Create bulk operation for a group (using pipeline)

```
--creationRampSec float32 Delay between every operation creation.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--group strings Identifies the target group on which this operation should be performed. (accepts pipeline)
-h, --help help for create
--operation string Operation prototype to send to each device in the group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Update an bulk operation

```
--creationRampSec float32 Delay between every operation creation.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Bulk Operation id (required) (accepts pipeline)
--processingMode string Cumulocity processing mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ available for multiple device types

```
--configurationType string Configuration type
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--description string Description of the configuration package
--deviceType string Device type filter. Only allow configuration to be applied to devices of this type (accepts pipeline)
--file string File to upload
Expand Down
110 changes: 110 additions & 0 deletions docs/go-c8y-cli/docs/cli/c8y/configuration/c8y_configuration_send.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
category: configuration
title: c8y configuration send
---
Send configuration to a device via an operation

### Synopsis

Create a new operation to send configuration to an agent or device.

If you provide the reference to the configuration (via id or name), then the configuration's
url and type will be automatically added to the operation.

You may also manually set the url and configurationType rather than looking up the configuration
file in the configuration repository.


```
c8y configuration send [flags]
```

### Examples

```
$ c8y configuration send --device mydevice --configuration 12345
Send a configuration file to a device
$ c8y devices list | c8y configuration send --configuration 12345
Send a configuration file to multiple devices
$ c8y devices list | c8y configuration send --configuration my-config-name
Send a configuration file (by name) to multiple devices
$ c8y configuration send --device 12345 --configurationType apt-lists --url "http://example.com/myrepo.list"
Send a custom configuration by manually providing the type and url
```

### Options

```
--configuration strings Configuration name or id
--configurationType string Configuration type. Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--description string Text description of the operation.
--device strings Identifies the target device on which this operation should be performed. (accepts pipeline)
-h, --help help for send
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars stringArray Body template variables
--url string Url to the configuration. Leave blank to automatically set it if a matching configuration is found in the c8y configuration repository
```

### Options inherited from parent commands

```
--abortOnErrors int Abort batch when reaching specified number of errors (default 10)
--allowEmptyPipe Don't fail when piped input is empty (stdin)
--cache Enable cached responses
--cacheBodyPaths strings Cache should limit hashing of selected paths in the json body. Empty indicates all values
--cacheTTL string Cache time-to-live (TTL) as a duration, i.e. 60s, 2m (default "60s")
-c, --compact Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal
--confirm Prompt for confirmation
--confirmText string Custom confirmation text
--currentPage int Current page which should be returned
--customQueryParam strings add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
--debug Set very verbose log messages
--delay string delay after each request, i.e. 5ms, 1.2s (default "0ms")
--delayBefore string delay before each request, i.e. 5ms, 1.2s (default "0ms")
--dry Dry run. Don't send any data to the server
--dryFormat string Dry run output format. i.e. json, dump, markdown or curl (default "markdown")
--examples Show examples for the current command
--filter stringArray Apply a client side filter to response before returning it to the user
--flatten flatten json output by replacing nested json properties with properties where their names are represented by dot notation
-f, --force Do not prompt for confirmation. Ignored when using --confirm
-H, --header strings custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
--includeAll Include all results by iterating through each page
-k, --insecure Allow insecure server connections when using SSL
-l, --logMessage string Add custom message to the activity log
--maxJobs int Maximum number of jobs. 0 = unlimited (use with caution!)
--noAccept Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect
--noCache Force disabling of cached responses (overwrites cache setting)
-M, --noColor Don't use colors when displaying log entries on the console
--noLog Disables the activity log for the current command
--noProgress Disable progress bars
--noProxy Ignore the proxy settings
-n, --nullInput Don't read the input (stdin). Useful if using in shell for/while loops
-o, --output string Output format i.e. table, json, csv, csvheader (default "table")
--outputFile string Save JSON output to file (after select/view)
--outputFileRaw string Save raw response to file (before select/view)
-p, --pageSize int Maximum results per page (default 5)
--progress Show progress bar. This will also disable any other verbose output
--proxy string Proxy setting, i.e. http://10.0.0.1:8080
-r, --raw Show raw response. This mode will force output=json and view=off
--select stringArray Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
--session string Session configuration
-P, --sessionPassword string Override session password
-U, --sessionUsername string Override session username. i.e. peter or t1234/peter (with tenant)
--silentExit Silent status codes do not affect the exit code
--silentStatusCodes string Status codes which will not print out an error message
--timeout string Request timeout duration, i.e. 60s, 2m (default "60s")
--totalPages int Total number of pages to get
-v, --verbose Verbose logging
--view string Use views when displaying data on the terminal. Disable using --view off (default "auto")
--withError Errors will be printed on stdout instead of stderr
--withTotalElements Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
-t, --withTotalPages Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages
--workers int Number of workers (default 1)
```

Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Update a configuration file

```
--configurationType string Configuration type
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--description string Description of the configuration package
--deviceType string Device type filter. Only allow configuration to be applied to devices of this type
--file string File to be uploaded
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Update custom properties of the current application (requires using application
```
--availability string Application will be applied to this type of documents, possible values [ALARM, AUDIT, EVENT, MEASUREMENT, OPERATION, *].
--contextPath string contextPath of the hosted application
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--externalUrl string URL to the external application
-h, --help help for update
--key string Shared secret of application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Change the status of a specific data broker connector by given connector id
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Data broker connector id (required) (accepts pipeline)
--processingMode string Cumulocity processing mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Create device group with custom properties
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--name string Device group name (accepts pipeline)
--processingMode string Cumulocity processing mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Update device group by id
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-d, --data stringArray static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Device group ID (required) (accepts pipeline)
--name string Device group name
Expand Down
Loading

0 comments on commit de13b50

Please sign in to comment.